API docs by Redocly

Documentação - API Leiloeiro (1.0.0)

Download OpenAPI specification:

Remoções

Endpoints relacionados a remoções dos bens.

Retorna a listagem de remoções.

Lista as remoções direcionadas ao leiloeiro utilizando os parametros 'with[]' conforme descrito abaixo para incluir no retorno do endpoint dados relevantes como dados do Bem(with[]=asset) e dados do local de origem da remoção(with[]=local).

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

search
string
Enum: "EM_TRANSITO" "CADASTRO" "REALIZADO" "CANCELADO" "REMOÇÃO FRUSTRADA"
Example: search=status_code:EM_TRANSITO

Filtro para status da remoção, utilizando o filtro search=status_code:"REALIZADO" para filtrar por status.

with[]
Array of strings
Items Enum: "local" "local_destiny" "asset"
Example: with[]=local&with[]=local_destiny&with[]=asset

Relações adicionais para carregar junto com a resposta. É possível incluir múltiplos valores, como with[]=local&with[]=asset.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "from": 1,
  • "last_page": 1,
  • "per_page": 50,
  • "to": 1,
  • "total": 1
}

Pesquisar remoção por ID

Retorna os detalhes de uma remoção específica, com a opção de incluir relacionamentos adicionais.

path Parameters
id
required
integer
Example: 1

ID da remoção a ser consultada.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

with[]
Array of strings
Example: with[]=asset.company&with[]=local

Relações adicionais a serem carregadas. Pode incluir asset.company, local, entre outros.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "from": 1,
  • "last_page": 1,
  • "per_page": 50,
  • "total": 1
}

Finalizar remoção e registrar entrada no pátio

Quando esse endpoint é acionado, a remoção é finalizada e é criada uma estadia no pátio configurado no sistema, a variavel "real_end_date" será utilizada para registrar a data em que a remoção foi finalizada e o Bem deu entrada no pátio iniciando a estadia.

path Parameters
id
required
integer
Example: 1

ID da remoção a ser finalizada.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: application/json
required
real_end_date
required
string <date>

A data de término da remoção. O formato deve ser YYYY-MM-DD.

Responses

Request samples

Content type
application/json
{
  • "real_end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Remoção finalizada e estadia criada"
}

Frustrar a remoção com motivo de cancelamento

Este endpoint é acionado quando há a necessidade de frustração de remoção, é necessário informar também o motivo da frustração.

path Parameters
id
required
integer
Example: 1

ID da remoção a ser frustrada.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: application/json
required
cancellation_note
required
string <text>

Motivo ou nota do cancelamento da remoção.

Responses

Request samples

Content type
application/json
{
  • "cancellation_note": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Remoção Atualizada!"
}

Fotos Vistoria

Endpoints relacionados a fotos de vistoria veicular.

Lista de Fotos de Vistoria

Endpoint para listar fotos de vistoria veicular vinculadas ao Bem passando pelo filtro o asset_id, retornará os dados da foto e o link para visualizar ou baixar, com a possibilidade de trazer os dados do bem passando o parametro "with[]=asset".

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

with
Array of strings
Example: with=asset

Relacionamento de dados, como o veículo (asset) relacionado à foto.

search
string
Example: search=asset_id:9

Parâmetro para filtrar os resultados, por exemplo, search=asset_id:9 para filtrar fotos pelo ID do ativo.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/photos?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/photos?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/photos",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Upload de Fotos de Vistoria

Endpoint para realizar o upload de fotos de vistoria para um veículo específico, passando o ID do Bem na URL.

path Parameters
asset_id
required
integer
Example: 1

ID do veículo que irá receber as fotos.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
required
Array of objects

Array contendo as informações das fotos.

Responses

Response samples

Content type
application/json
{
  • "message": "Fotos salvas com sucesso!"
}

Deletar Foto de Vistoria

Endpoint para deletar uma foto de vistoria associada a um veículo específico.

path Parameters
id
required
integer
Example: 1

ID da foto a ser deletada.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Recurso deletado"
}

Bens

Endpoints relacionados aos Bens do patrimonio.

Lista de Estoque de Veículos

Endpoint para listar veículos em estoque, com entradas ativas no pátio.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

with
Array of strings
Example: with=vehicle.doc_inspection

Parâmetro para incluir o bem relacionado à estadia e o documento de vistoria (se disponível).

sort[by]
string
Example: sort[by]=start_date_stay

Parâmetro utilizado para ordenar a listagem dos resultados.

sort[order]
string
Enum: "desc" "asc"
Example: sort[order]=desc

Ordenar o parâmetro sort[by] em ordem crescente ou decrescente.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/stays?page=1",
  • "last_page_url": "/stays?page=1",
  • "next_page_url": null,
  • "prev_page_url": null,
  • "total": 1
}

Pesquisar Bens Regularizados ou com bloqueio de vendas.

Retorna os detalhes dos bens, com a opção de incluir relacionamentos adicionais com o "with[]=".

Lista de status disponiveis no item sell_status:

  • "VENDA_AGUARDANDO_BLOQUEIO"
  • "VENDA_LIBERADA"
  • "VENDA_BLOQUEADA"
  • "EM_ANALISE_VENDA"
  • "VENDIDO"
  • "REVERSAO"

Utilizando o filtro "search" conseguimos filtrar apenas veiculos regularizados ou com algum bloqueio, conforme descrito abaixo.

  • Bens Regularizados: search=dispatchs.status:REGULARIZADO
  • Bens Com Liberação antecipada: search=dispatchs.early_release:1
  • Bens Bloqueados: search=sell_status:VENDA_BLOQUEADA

Para visualizar informações de regularização utilizamos o relacionamento: "with[]=dispatch.pendency". Com isso conseguimos verificar se houve BAIXA DE SUCATA ou REMARCAÇÃO DE CHASSI.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

search
string
Example: search=dispatch.status:REGULARIZADO

Filtros de pesquisa, como dispatch.status:REGULARIZADO.

with[]
Array of strings
Example: with[]=dispatchs&with[]=dispatchs.dispatcher&with[]=devolution&with[]=advisory&with[]=stay&with[]=lastEventsAssets.eventRemoved&with[]=statusLog

Relações adicionais a serem carregadas. Pode incluir dispatchs, dispatchs.dispatcher, entre outros.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/assets?page=1",
  • "last_page_url": "/assets?page=1",
  • "next_page_url": null,
  • "prev_page_url": null,
  • "total": 1
}

Listar pré-ativos Bradesco Seguro

Endpoint para listar todos os pré-ativos cadastrados.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

search
string
Example: search=car_plate:QIT0G21

Filtros de pesquisa, como car_plate:QIT0G21.

with[]
Array of strings
Example: with[]=dispatchs&with[]=asset

Relações adicionais a serem carregadas. Pode incluir dispatchs, dispatchs.dispatcher, entre outros.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Criar pré-ativo Bradesco Seguro

Cria um novo pré-ativo.

query Parameters
client_id
required
string
secret_id
required
string
Request Body schema: multipart/form-data
required
car_plate
required
string

Placa do veículo

warning_number
required
string

Número de aviso

start_date_stay
required
string <date>

Data de início da estadia

courtyard_id
required
integer

ID do local de estadia

file
required
string <binary>

Arquivo de vistoria

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "car_plate": "string",
  • "warning_number": "string",
  • "start_date_stay": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z"
}

Detalhar pré-ativo Bradesco Seguro

Retorna os detalhes de um pré-ativo específico.

path Parameters
id
required
integer
query Parameters
client_id
required
string
secret_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "car_plate": "string",
  • "warning_number": "string",
  • "start_date_stay": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z"
}

Atualizar pré-ativo Bradesco Seguro

Atualiza os dados de um pré-ativo existente.

path Parameters
id
required
integer
query Parameters
client_id
required
string
secret_id
required
string
Request Body schema: multipart/form-data
required
car_plate
string

Placa do veículo

warning_number
string

Número de aviso

start_date_stay
string <date>

Data de início da estadia

courtyard_id
integer

ID do local de estadia

file
string <binary>

Arquivo de vistoria

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "status": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Deletar pré-ativo Bradesco Seguro

Remove um pré-ativo pelo ID.

path Parameters
id
required
integer
query Parameters
client_id
required
string
secret_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Recurso deletado"
}

Saída de Estoque

Endpoint para registrar um fluxo de saída de um Bem do estoque. A estadia é finalizada.

path Parameters
stay_id
required
integer
Example: 1

ID da estadia

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
required
file
string <binary>

Anexo opcional (arquivo PDF, PNG, JPG)

end_date_stay
required
string <date>

Data de término da estadia

delivered_to
required
string

Nome do responsável pela retirada

motive
required
string
Enum: "Venda" "Inutilizado" "Solicitação do Bradesco"

Motivo da retirada

document
required
string <string>

Documento do responsável (CPF)

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Recurso atualizado com sucesso!"
}

Documentos

Endpoints relacionados aos Documentos do Bem.

Retorna a listagem de documentos relacionados ao Bem.

Lista os documentos relacionados ao Bem.

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

filter
string
Examples:
  • filter=asset_id:7 -
  • filter=car_plate:ABC-1234 -
  • filter=chassi:9BWZZZ377VT004251 -
  • filter=contract:123456478 -

Filtro opcional para especificar o ID do BEM, placa, chassis, ou contrato. Passando o valor do parametro "filter=chave:valor".

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ]
}

Download de Documentos.

Endpoint para realizar download do documento pelo ID, retorna um link para visualizar/baixar o arquivo.

path Parameters
id
required
integer

ID do Documento

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "message": "Documento encontrado!",
  • "file": "Link temporário para download do documento.",
  • "status": 200,
  • "success": true
}

Documentos ATPV

Endpoints relacionados aos Documentos ATPV do Bem.

Lista de ATPVs

Lista os documentos ATPV armazenados no sistema, com a opção de incluir detalhes dos ativos associados.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "total": 1,
  • "data": [
    ]
}

Subir arquivo ATPV

Endpoint para subir arquivo ATPV. O arquivo será processado e registrado no sistema de documentos.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo de ATPV (PDF, PNG, JPEG, TIFF).

event_asset_id
required
integer

Id do lote, pode ser encontrado em Lista de Lotes.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Documento cadastrado com sucesso!"
}

Download do ATPV

Realiza o download do documento ATPV solicitado através do ID.

path Parameters
id
required
integer
Example: 1

ID do ATPV a ser baixado.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Documento encontrado!",
  • "file": "link-cdn",
  • "status": 200,
  • "success": true
}

Documentos de Repasse

Endpoints relacionados aos Documentos de Repasse do Bem.

Lista de Documentos De Repasse

Obtém uma lista de documentos de repasse(Documento com as informações de valores a serem repassados para o banco do bem vendido), com base nos parâmetros fornecidos.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

with[]
string
Example: with[]=event

Parâmetro opcional para incluir dados relacionados, como eventos.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/transfer-receipts?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/transfer-receipts?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/transfer-receipts",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Cadastrar documentos de repasse

Esse endpoint permite o envio de documentos de repasse(Documento com as informações de valores a serem repassados para o banco do bem vendido), para o sistema.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
document
required
string <binary>

O arquivo de documento de repasse.

event_id
required
integer

ID do evento relacionado ao documento.

company_id
required
integer

ID da empresa/parceiro relacionado ao documento.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Documento cadastrado com sucesso!"
}

Lista de Documentos De Repasse Reprovados

Obtém uma lista de documentos de repasse reprovados pelo patrimônio devido a alguma divergência de informação.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

search
string

Filtro para listar apenas documentos reprovados. Passando o valor do parametro '?searchLike=user_status_checked:REPROVADO'

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/transfer-receipts?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/transfer-receipts?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/transfer-receipts",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Atualizar um documentos de repasse reprovado

Caso o documento seja reprovado pelo patrimônio, é possível reenviá-lo informando o ID do documento junto com um novo arquivo (FILE).

path Parameters
id
required
integer

ID do documento.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
document
required
string <binary>

O arquivo de documento de repasse.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Documento atualizado com sucesso!"
}

Download do Documento de Repasse.

Realiza o download do documento de repasse(Documento com as informações de valores a serem repassados para o banco do bem vendido), solicitado através do ID.

path Parameters
id
required
integer
Example: 1

ID do Documento de Repasse a ser baixado.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Documento encontrado!",
  • "file": "link-cdn",
  • "status": 200,
  • "success": true
}

Documentos de Vendas

Endpoints relacionados aos Documentos de Venda do Bem.

Lista de Nota de Venda

Lista os documentos de Nota de Venda(Documento gerado quando o Bem vendido, com dados de venda), com a opção de incluir detalhes dos bens associados.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "total": 1,
  • "data": [
    ],
  • "first_page_url": "/sell-note?page=1",
  • "last_page": 1,
  • "links": [
    ]
}

Subir arquivo Nota de Venda

Endpoint para subir arquivo Nota de Venda(Documento gerado quando o Bem vendido, com dados de venda). O arquivo será processado e registrado no sistema de documentos.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo de Nota de Venda (PDF ou imagens suportadas: PNG, JPEG, JPG, TIFF)

event_asset_id
required
integer

ID do lote, pode ser encontrado em Lista de Lotes

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Documento cadastrado com sucesso!"
}

Download da Nota de Venda

Realiza o download do documento de Nota de Venda(Documento gerado quando o Bem vendido, com dados de venda) solicitado através do ID.

path Parameters
id
required
integer
Example: 1

ID da Nota de Venda a ser baixado.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Documento encontrado!",
  • "file": "link-cdn",
  • "status": 200,
  • "success": true
}

Documentos de Regularização

Endpoints relacionados aos Documentos de regularização do Bem.

Download do documento de regularização do bem.

Retorna um link para baixar o documento através do ID do despacho, é encontrado no endpoint de "Pesquisar Bens Regularizados ou com bloqueio de vendas".

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ]
}

Laudos

Endpoints relacionados aos Laudos do Bem.

Lista de Laudos

Retorna uma lista de laudos, passando o parametro "with[]=asset" retornará os dados do Bem relacionado ao laudo.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

with[]
Array of strings
Example: with[]=asset

Parâmetro para incluir informações do Bem relacionado ao laudo.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/list-reports?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/list-reports?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/list-reports",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Download do Laudo

Endpoint para realizar download do laudo pelo ID, retorna um link para visualizar/baixar o arquivo.

path Parameters
id
required
integer

ID do Laudo.

header Parameters
client_id
required
string

Id fornecido pelo Bradesco.

secret_id
required
string

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Laudo encontrado!",
  • "file": "Link temporario para download do arquivo.",
  • "status": 200,
  • "success": true
}

Upload em lote de Laudos

Endpoint para realizar upload em lote de laudos através de arquivo ZIP.

Formato de nomenclatura dos arquivos: Utilize o seguinte formato nos nomes dos arquivos: PLACA_TIPODOCUMENTO_STATUS.EXTENSAODOARQUIVO

Em caso do status APROVADO, não necessita ser adicionado ao nome do arquivo.

Tipos de documento e sufixos:

  • Cautelar: CAU
  • ECV: ECV
  • Mini laudo: MINI
  • Cautelar de Montana: CMON

Status e exemplos:

  • Aprovado: AHI-3007_CAU.jpg
  • Aprovado com restrição: AHI-3007_CAU_RESTRICAO.jpg
  • Reprovado: AHI-3007_CAU_REPROVADO.jpg
header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
required
documents
required
string <binary>

Arquivo ZIP contendo os laudos para upload em lote

Responses

Response samples

Content type
application/json
{
  • "message": "Upload em lote realizado com sucesso!",
  • "status": 200,
  • "success": true,
  • "data": {
    }
}

Upload único de Laudo

Endpoint para realizar upload de um laudo individual.

Tipos de documento aceitos:

  • ecv - ECV
  • cautelar - Cautelar
  • mini_laudo - Mini laudo
  • cautelar_montana - Cautelar de Montana

Status possíveis:

  • APROVADO - Aprovado
  • APROVADO_COM_RESTRICAO - Aprovado com restrição
  • REPROVADO - Reprovado

Formatos de arquivo aceitos: PDF, JPG, JPEG, PNG Tamanho máximo: 10MB

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
required
document
required
string <binary>

Arquivo do laudo (PDF, JPG, JPEG ou PNG)

car_plate
required
string <= 10 characters

Placa do veículo

type_document
required
string
Enum: "ecv" "cautelar" "mini_laudo" "cautelar_montana"

Tipo do documento

status
required
string
Enum: "APROVADO" "APROVADO_COM_RESTRICAO" "REPROVADO"

Status do laudo

Responses

Response samples

Content type
application/json
{
  • "message": "Laudo enviado com sucesso!",
  • "status": 200,
  • "success": true,
  • "data": {
    }
}

Leilões

Endpoints relacionados aos Leilões.

Lista os Leilões cadastrados.

Endpoint listar os leilões e as tags relacionadas a este evento.

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "from": 1,
  • "last_page": 1,
  • "per_page": 50,
  • "to": 1,
  • "total": 1
}

Cadastro de leilão.

Endpoint cadastrar os leilões.

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
name
string

Nome do leilão

event_start_date
string <date-time>

Data e hora do início do leilão

Responses

Request samples

Content type
application/json
{
  • "name": "Leilão Sucata",
  • "event_start_date": "2024-01-10 10:00:00"
}

Response samples

Content type
application/json
{
  • "message": "Evento Criado!",
  • "status": 201,
  • "data": {
    }
}

Pesquisar leilão

path Parameters
id
required
integer

ID do leilão

query Parameters
with[]
Array of strings
Example: with[]=EventsAssets

Parâmetro para incluir dados relacionados, como EventsAssets

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "message": "Recurso encontrado",
  • "status": 200,
  • "data": {
    }
}

Editar leilão

Atualiza as informações de um leilão existente.

Não será possível editar informações de um leilão(Datas, Nome) após ele ser aprovado pela equipe do patrimônio.

Para FINALIZAR um leilão, deve mandar o campo "situation" com a string "Realizado", apenas após a aprovação do leilão.

path Parameters
id
required
integer
Example: 1

ID do leilão

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: application/json

Dados para editar o leilão

name
string
event_start_date
string
situation
required
string

Para finalizar um evento, o campo de situação deve ser "Realizado"

Responses

Request samples

Content type
application/json
{
  • "name": "Leilão Sucata",
  • "event_start_date": "2024-01-10 10:00:00",
  • "situation": "Realizado"
}

Response samples

Content type
application/json
{
  • "message": "Recurso atualizado",
  • "status": 200,
  • "data": {
    }
}

Cancelar leilão

Desativa um leilão existente.

path Parameters
id
required
integer
Example: 1

ID do leilão

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Leilão Desativado"
}

Prontos para Leilão.

Endpoint para listar veículos prontos para leilão.

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "from": 1,
  • "last_page": 1,
  • "per_page": 50,
  • "to": 1,
  • "total": 1
}

Tags de Leilões

Endpoints relacionados as Tags.

Listar Tag de Leilão

Endpoint para listar as tags de leilão.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "from": 1,
  • "last_page": 1,
  • "per_page": 50,
  • "to": 1,
  • "total": 1
}

Cadastro de Tag de Leilão

Endpoint para cadastrar uma nova tag de leilão. As tags serão necessárias para distribuição automatica do Bem ao Leilão.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
name
required
string

Nome da tag de leilão

Responses

Request samples

Content type
application/json
{
  • "name": "Tag de Sucata"
}

Response samples

Content type
application/json
{
  • "status": 201,
  • "message": "Recurso criado"
}

Pesquisar Tag de Leilão

Endpoint para pesquisar uma tag de leilão específica.

path Parameters
id
required
integer
Example: 1

ID do Relacionamento (Leilão x Tags)

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "from": 1,
  • "last_page": 1,
  • "per_page": 50,
  • "to": 1,
  • "total": 1
}

Editar Tag de Leilão

Endpoint para editar uma tag de leilão existente.

path Parameters
id
required
integer
Example: 1

ID da Tag de Leilão

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: application/json
name
required
string

Nome da tag do leilão

Responses

Request samples

Content type
application/json
{
  • "name": "Tag de Sucata"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Recurso atualizado"
}

Desativar Tag de Leilão

Endpoint para desativar (deletar) uma tag de leilão existente.

path Parameters
id
required
integer
Example: 1

ID da Tag de Leilão

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: application/json
name
required
string

Nome da tag do leilão

Responses

Request samples

Content type
application/json
{
  • "name": "Tag de Sucata"
}

Response samples

Content type
application/json
{
  • "status": 204,
  • "message": "Recurso deletado"
}

Relacionamento de Tags entre Leilões e Bens

Endpoints relacionados aos Relacionamentos de Tags com Leilões e Bens.

Listar Relacionamento entre Tags e Leilões

Nesta listagem teremos um retorno de uma tabela intermediária onde terá o registro de leilões e suas tags relacionadas.

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "first_page_url": "events-tags?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "events-tags?page=1",
  • "links": [
    ],
  • "next_page_url": "string",
  • "path": "events-tags",
  • "per_page": 100,
  • "prev_page_url": "string",
  • "to": 2,
  • "total": 2
}

Cadastro de Relacionamento entre Tags e Leilões

Relaciona uma tag ao leilão, podemos cadastrar diversas tags a um mesmo leilão acessando este endpoint cada vez que deseja incluir uma tag a um leilão.

Neste leilão serão incluidos os veiculos que tenham relacionamento com a mesma tag. Seguindo as regras abaixo:

  • O Bem será direcionado ao Leilão com a mesma Tag.
  • O direcionamento será para o leilão com a data mais próxima*
  • Seguindo a regra anterior os Bens serão distribuidos apenas para leilões com uma data de inicio de no minimo 3 dias de diferença da data atual.
query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
event_id
integer

ID do Leilão existente

tag_id
integer

ID da Tag que deseja relacionar ao Leilão

Responses

Request samples

Content type
application/json
{
  • "event_id": 1,
  • "tag_id": 1
}

Response samples

Content type
application/json
{
  • "message": "Recurso criado",
  • "status": 201
}

Pesquisar Relacionamento entre Tags e Leilões

path Parameters
id
required
integer
Example: 1

ID do Relacionamento (Tag x Leilão)

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "message": "Recurso encontrado",
  • "status": 200,
  • "data": {
    }
}

Editar Relacionamento entre Tags e Leilões

path Parameters
id
required
integer
Example: 1

ID do Relacionamento (Tag x Leilão)

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json

Dados para editar o relacionamento entre Tag e Leilão

event_id
integer
tag_id
integer

Responses

Request samples

Content type
application/json
{
  • "event_id": 1,
  • "tag_id": 1
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Recurso atualizado"
}

Desativar Relacionamento entre Tags e Leilões

path Parameters
id
required
integer
Example: 1

ID do Relacionamento (Tag x Leilão)

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "status": 204,
  • "message": "Recurso deletado"
}

Relacionar Tag a um Bem.

Relaciona uma tag a um Bem, um Bem só poderá ter uma tag.

Os Bens serão incluidos em um leilão, seguindo as regras abaixo:

  • O Bem será direcionado ao Leilão com a mesma Tag.
  • O direcionamento será para o leilão com a data mais próxima*
  • Seguindo a regra anterior os Bens serão distribuidos apenas para leilões com uma data de inicio de no minimo 3 dias de diferença da data atual.
query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
asset_id
integer

ID do Veículo

tag_id
integer

ID da Tag que deseja relacionar ao Veículo

Responses

Request samples

Content type
application/json
{
  • "asset_id": 1,
  • "tag_id": 1
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Recurso atualizado com sucesso!"
}

Remover Tag do Veículo

Neste endpoint podemos remover uma tag de um veiculo para posteriormente incluirmos uma nova tag.

path Parameters
id
required
integer
Example: 1

ID do veículo

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Recurso atualizado com sucesso!"
}

Relacionamentos entre Bens e Leilões

Endpoints relacionados a informações de Bens nos Leilões.

Lista de Bens relacionados ao evento.

Este endpoint é o registro das informações de um Bem em um Evento, neste endpoint retornará informações importantes como valor minimo de venda, valor de arremate, status do veiculo no evento.

STATUS DISPONIVEIS NO MOMENTO:

  • REMOVIDO
  • PRONTO_PARA_VENDA
  • A_VENDA
  • AGUARDANDO_PAGAMENTO
  • CONDICIONAL_ACEITA
  • CONDICIONAL_NEGADA
  • PAGO
  • VMV_ATINGIDO
  • DESISTENCIA
  • ANUNCIO_CANCELADO
  • CONDICIONAL
  • SEM_OFERTA
  • CONTRAPROPOSTA
  • CONTRAPROPOSTA_ACEITA
  • CONTRAPROPOSTA_NEGADA
  • VENDA_NEGADA
query Parameters
with[asset]
string

Traz o relacionamento do lote com o bem.

with[event]
string

Traz o relacionamento do lote com o leilão.

search
string

Pode ser utilizado para filtrar a lista por algum parâmetro, Ex: &search=status:CONDICIONAL_ACEITA, ou search=event_id:10(Para listar os itens por um evento especifico)

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/events-assets?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/events-assets?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/events-assets",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Atualizar N° Lote

Enpoint para atualizar N° Lote do Bem no Leilão.

path Parameters
id
required
integer

ID do "events-assets"(ID da Listagem de Bens relacionados ao evento.)

header Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
number_batch
string

Lote (opcional)

Responses

Request samples

Content type
application/json
{
  • "number_batch": "1234"
}

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "next_page_url": null,
  • "path": "/events-assets",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Cancelar Venda

Após o cancelamento da venda, o status do lote (events_assets) deve ficar como "DESISTENCIA".

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
asset_id
required
integer

Id do veículo/bem

event_id
required
integer

Id do evento

Responses

Request samples

Content type
application/json
{
  • "asset_id": 45,
  • "event_id": 68
}

Response samples

Content type
application/json
{
  • "message": "Venda Cancelada com sucesso!",
  • "status": 200,
  • "success": true,
  • "data": {
    }
}

Remover Veículo do Evento

Endpoint para remover o Bem do leilão. Diferente do cancelamento de venda, este endpoint é para ser usado quando o Bem ainda não foi arrematado.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
document
string <binary>

Arquivo de exclusão/baixa

asset_id
required
integer

Id do veículo/bem

event_id
required
integer

Id do evento

reason_for_exclusion
string

Motivo da exclusão do veículo do evento

Responses

Response samples

Content type
application/json
{
  • "message": "O Bem foi removido do evento com sucesso!",
  • "status": 200,
  • "success": true
}

Contra Proposta

Endpoint para uma aceitar ou rejeitar uma Contra Proposta de Venda.

Para Aceitar ou Rejeitar necessário atualizar a variavel status com os valores abaixo:

  • CONTRAPROPOSTA_ACEITA
  • CONTRAPROPOSTA_NEGADA
query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
required
asset_id
required
integer

Id do bem

event_id
required
integer

Id do evento

status
required
string

Status obrigatório, deve ser: CONTRAPROPOSTA_ACEITA ou CONTRAPROPOSTA_NEGADA

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Evento atualizado com sucesso!"
}

Incluir Informações no Veículo do Evento

Endpoint para incluir informações relevantes do veículo no evento. Será registrado na events-assets, e não no Bem.

path Parameters
id
required
integer
Example: 1

ID do Relacionamento (Evento x Asset)

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
info
required
string

Informações para o veículo do evento.

Responses

Request samples

Content type
application/json
{
  • "info": "Informações detalhadas sobre o veículo."
}

Response samples

Content type
application/json
{
  • "message": "O Bem foi atualizado no evento com sucesso!",
  • "status": 200,
  • "success": true
}

Atualização de Valores de Arremate.

Atualiza as informações de Arremate do Lote no leilão junto com as informações do cliente arrematante.

Caso seja necessario atualizar as informações de endereço e contato do cliente arrematante. Pode enviar os dados novamente atualizados, apenas estes dados serão atualizados.

Em caso de envio de informações de arremate, mesmo com o cliente com restrições, as informações serão atualizadas porém o status da venda será registrado como "RECUSADO_POR_RESTRICAO".

Caso necessario enviar os dados de de representante ou Sócio da Empresa mandar a varial company_partner = 1 os dados do sócio dentro do array partners.

path Parameters
event_asset_id
required
integer

ID do lote (events_assets), pode ser encontrado em Lista de Lotes

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
name_client
required
string

Nome do Cliente

cpf
required
string

CPF do cliente

cnpj
required
string

CNPJ do cliente

ddd_phone_1
string

DDD do telefone 1

phone_1
string

Telefone 1 do cliente

ddd_phone_2
string

DDD do telefone 2

phone_2
string

Telefone 2 do cliente

email
string

Email do cliente

street_type
string

Tipo do logradouro (Rua, Avenida)

public_place
string

Endereço do cliente

number
string

Número residencial

district
string

Bairro do cliente

city
string

Cidade do cliente

state
string

UF do cliente

cep
string

CEP do cliente

complement
string

Complemento

value_finish
required
number <float>

Valor final

fee_value
number <float>

Valor de taxas

commission_value
number <float>

Valor da comissão

other_services_value
number <float>

Valor de outros serviços

credited_value
number <float>

Valor creditado

credit_date
string <date>

Data do crédito

sale_type
string

Enum (On-line ou Presencial)

payment_date
string <date>

Data do pagamento

payment_method
string

Método de pagamento.

company_partner
boolean

1 para casos onde tenha que enviar socios relacionados para a empresa e 0 para casos que não precise informar.

Array of objects

Lista de sócios do cliente

Responses

Request samples

Content type
application/json
{
  • "name_client": "string",
  • "cpf": "string",
  • "cnpj": "string",
  • "ddd_phone_1": "string",
  • "phone_1": "string",
  • "ddd_phone_2": "string",
  • "phone_2": "string",
  • "email": "string",
  • "street_type": "string",
  • "public_place": "string",
  • "number": "string",
  • "district": "string",
  • "city": "string",
  • "state": "string",
  • "cep": "string",
  • "complement": "string",
  • "value_finish": 0.1,
  • "fee_value": 0.1,
  • "commission_value": 0.1,
  • "other_services_value": 0.1,
  • "credited_value": 0.1,
  • "credit_date": "2019-08-24",
  • "sale_type": "string",
  • "payment_date": "2019-08-24",
  • "payment_method": "string",
  • "company_partner": true,
  • "partners": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Valores cadastrados com sucesso!",
  • "updated_data": {
    }
}

Cadastro em Lote de Valores de Arremate

Atualiza as informações de Arremate do Bem no leilão em lote mandando um array com as informações poderá atualizar diversos itens ao mesmo tempo.

Caso seja necessario atualizar as informações de endereço e contato do cliente arrematante. Pode enviar os dados novamente atualizados, apenas estes dados serão atualizados.

Em caso de envio de informações de arremate, mesmo com o cliente com restrições, as informações serão atualizadas porém o status da venda será registrado como "RECUSADO_POR_RESTRICAO".

Caso necessario enviar os dados de de representante ou Sócio da Empresa mandar a varial company_partner = 1 os dados do sócio dentro do array partners.

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
Array of objects

Values deve ser um array contendo os dados de cada valor de arremate

Responses

Request samples

Content type
application/json
{
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Valores cadastrados com sucesso!",
  • "updated_data": [
    ]
}

Atualização de Valores e Informações de Pagamento do Lote.

Atualiza as informações de pagamento do Lote no leilão.

O lote deve estar com algum status que informe que ele foi vendido.

status:

  • CONDICIONAL_ACEITA
  • CONTRAPROPOSTA_ACEITA
  • VMV_ATINGIDO
path Parameters
event_asset_id
required
integer

ID do lote (events_assets), pode ser encontrado em Lista de Lotes

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: application/json
required
fee_value
number <float>

Valor de taxas

commission_value
number <float>

Valor da comissão

other_services_value
number <float>

Valor de outros serviços

credited_value
number <float>

Valor creditado

credit_date
string <date>

Data do crédito

sale_type
string

Enum (On-line ou Presencial)

payment_date
string <date>

Data do pagamento

payment_method
string

Método de pagamento.

Responses

Request samples

Content type
application/json
{
  • "fee_value": 0.1,
  • "commission_value": 0.1,
  • "other_services_value": 0.1,
  • "credited_value": 0.1,
  • "credit_date": "2019-08-24",
  • "sale_type": "string",
  • "payment_date": "2019-08-24",
  • "payment_method": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Valores cadastrados com sucesso!",
  • "updated_data": {
    }
}

Restrições

Endpoints relacionados a consulta de restrições.

Consulta de restrição CPF

Endpoint para consultar restrições no CPF informado.

path Parameters
cpf
required
string
Example: 12312312312

CPF para consulta (11 caracteres)

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

Id fornecido pelo Bradesco

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "status": false,
  • "message": "CPF sem restrição",
  • "consulted_in": "2024-11-11 08:40:51"
}

Consulta de restrição CNPJ

path Parameters
cnpj
required
string
Example: 12345678000145

CNPJ da consulta, dígito 14 caracteres

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "status": false,
  • "message": "CNPJ sem restrição",
  • "consulted_in": "2024-11-11 08:40:51"
}

Devoluções

Endpoints relacionados a devoluções

Solicitar a devolução de um bem

Este endpoint deve ser utilizado quando a devolução do bem for solicitada diretamente por um oficial no pátio do leiloeiro. É obrigatório registrar essa devolução por meio desta interface.

📌 Regras Condicionais

Os seguintes campos são obrigatórios apenas em determinadas condições:

  • fileRestitution
    Obrigatório se: is_restitution = 1

  • fileCompany
    Obrigatório se: is_pj = 1

  • cep
    Obrigatório se:

    • in_patio = 0 ou
    • motivation_status = APREENSAO_INDEVIDA

  • address, number, city, state
    Cada um obrigatório se: in_patio = 0

  • cnpj, company_name, full_address
    Cada um obrigatório se: motivation_status = APREENSAO_INDEVIDA

path Parameters
id
required
integer
Example: 123

ID do bem que será bloqueado.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
is_return
required
string
Value: "1"

Status do bem será registrado como DEVOLVIDO.

status
required
string
Value: "DEVOLVIDO"

Status do bem será registrado como DEVOLVIDO.

type_block
required
string
Value: "is_return"

Registrar o bloqueio do veiculo para nao seguir o fluxo automatico do sistema.

substatus
required
string
Enum: "devolucao" "devolucao_doc_ok" "purgacao_da_mora"

Tipo do bloqueio.

file
required
string <binary>

Comprovante de devolução (jpg, jpeg, png, pdf)

is_restitution
required
string
Enum: "0" "1"

Item para registrar se será necessário restituir um terceiro no processo devolução do Bem.

fileRestitution
string <binary>

Arquivo comprovando o gasto que será restituido. Obrigatório se is_restitution = 1

is_pj
required
string
Enum: "0" "1"

Caso o bem for devolvido para PJ.

fileCompany
string <binary>

Documento do CNPJ. Arquivo obrigatório se is_pj = 1

in_patio
required
string
Enum: "0" "1"

Item para registrar que o Bem foi retirado direto do Patio, caso sim enviar como 1, se for necessario entregar o Bem em outro local enviar o valor 0 e preencher os dados de endereço.

name
required
string
cpf
required
string
phone
required
string
contract_status
string
Enum: "REATIVADO" "QUITADO"

Caso tenha a informação do status do contrato enviar neste item.

motivation_status
required
string
Enum: "DETERMINACAO_JUDICIAL" "PURGA_DA_MORA" "ACORDO" "APREENSAO_INDEVIDA"

Motivo solicitação da devolução.

observation_block
required
string

Registrar uma nota explicando ou detalhando o processo.

cep
string

Obrigatório se in_patio = 0 ou motivation_status = APREENSAO_INDEVIDA

address
string
number
string
city
string
state
string
cnpj
string
company_name
string
full_address
string

Responses

Response samples

Content type
application/json
{
  • "message": "Bloqueio processado com sucesso!"
}

Listar devoluções

Endpoint para listar devoluções com múltiplos filtros de busca. É possível filtrar por ID, placa, chassi, e aplicar busca por nome aproximado, além de incluir relacionamentos como asset.

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

searchLike
string
Example: searchLike=name:JOSE

Filtro de busca aproximada, ex searchLike=name:JOSE

with[]
Array of strings
Example: with[]=asset

Relações adicionais a serem carregadas, como asset.

search
string
Example: search=car_plate:AAA-9999

Filtros de busca. Podem ser usados múltiplos, como search=id:1, search=car_plate:AAA-9999, search=chassis:XXXXXXXXXXXXXXX

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Completar devolução

Endpoint para marcar uma devolução como completa, informando a data de conclusão.

path Parameters
id
required
integer
Example: 69387

ID da devolução a ser completada.

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Request Body schema: application/json
required
completion_date
required
string <date>

Data de conclusão da devolução

Responses

Request samples

Content type
application/json
{
  • "completion_date": "2025-08-28"
}

Response samples

Content type
application/json
{
  • "message": "Devolução marcada como completa com sucesso",
  • "status": 200,
  • "data": {
    }
}

Listar documentos de uma devolução

Endpoint para listar todos os documentos relacionados a uma devolução específica através do ID.

path Parameters
id
required
integer
Example: 69387

ID da devolução para buscar os documentos.

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{}

Upload de documento de bloqueio

Endpoint para fazer upload de documentos de bloqueio relacionados a devoluções.

path Parameters
id
required
integer
Example: 6210

ID do bloqueio (blocking_id)

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo a ser enviado

type
required
string
Enum: "restitution" "company" "proof_return"

Tipo do documento. Valores possíveis:

  • restitution
  • company
  • proof_return

Responses

Response samples

Content type
application/json
{
  • "message": "Documento enviado com sucesso",
  • "status": 200,
  • "data": {
    }
}

Comunicação de Venda

Endpoints relacionados a comunicação de venda

Buscar comunicação de venda

Endpoint para buscar veículos que já foram vendidos e estão disponíveis para comunicar que foram vendidos. A busca é realizada por placa ou chassi do veículo.

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

search
required
string
Example: search=AAA-9999

Busca por placa ou chassi do veículo vendido.

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "car_plate": "AAA-9999",
  • "chassis": "9BWZZZZZZZZZZZZZZ",
  • "sale_date": "2024-01-15",
  • "sale_value": 25000,
  • "buyer_name": "João Silva",
  • "status": "vendido"
}

Listar comunicações de venda

Endpoint para listar comunicações de venda com filtros avançados por status e relacionamentos. Permite filtrar por múltiplos status simultaneamente e incluir dados relacionados como leiloeiro, despachante e bem.

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

with[]
Array of strings
Items Enum: "auctioneer" "dispatcher" "asset"
Example: with[]=auctioneer&with[]=dispatcher&with[]=asset

Relacionamentos adicionais a serem carregados. Valores aceitos: auctioneer, dispatcher, asset

searchOr
string
Example: searchOr=status:PENDENTE DE ENVIO;status:ENVIADO AO DESPACHANTE;status:RECEBIDO PELO DESPACHANTE

Filtro de busca com operador OR para múltiplos valores. Formato: campo:valor1;campo:valor2;campo:valor3 Exemplo para filtrar por status: status:PENDENTE DE ENVIO;status:ENVIADO AO DESPACHANTE;status:RECEBIDO PELO DESPACHANTE

sort[by]
string
Enum: "id" "created_at" "updated_at" "status"
Example: sort[by]=id

Campo para ordenação dos resultados

sort[order]
string
Enum: "ASC" "DESC"
Example: sort[order]=DESC

Ordem da classificação

page
integer
Example: page=1

Número da página para paginação

per_page
integer
Example: per_page=20

Quantidade de itens por página

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Criar comunicação de venda

Endpoint para criar uma comunicação de venda para um veículo específico através do asset_id.

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Request Body schema: application/json
required
asset_id
required
integer

ID do bem/veículo para criar a comunicação de venda

Responses

Request samples

Content type
application/json
{
  • "asset_id": 12345
}

Response samples

Content type
application/json
{
  • "id": 67890,
  • "asset_id": 12345,
  • "status": "comunicação_criada",
  • "created_at": "2024-01-15T10:30:00Z",
  • "message": "Comunicação de venda criada com sucesso"
}

Enviar comunicação de venda para despachante

Endpoint para enviar uma comunicação de venda específica para o despachante vinculado ao processo.

path Parameters
id
required
integer
Example: 67890

ID da comunicação de venda

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "id": 67890,
  • "status": "enviado_para_despachante",
  • "sent_at": "2024-01-15T14:30:00Z",
  • "dispatcher_id": 54321,
  • "message": "Comunicação de venda enviada para o despachante com sucesso"
}

Upload de arquivo de comprovação

Endpoint para fazer upload de arquivo de comprovação para uma comunicação de venda específica. Aceita arquivos PDF, JPG, JPEG, PNG e TXT com tamanho máximo de 20MB.

Importante: Ao fazer o upload do comprovante, o processo de comunicação de venda será automaticamente concluído e finalizado.

path Parameters
id
required
integer
Example: 67890

ID da comunicação de venda

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
proof_file_path
required
string <binary>

Arquivo de comprovação (PDF, JPG, JPEG, PNG, TXT) - máximo 20MB

Responses

Response samples

Content type
application/json
{
  • "id": 67890,
  • "file_path": "/uploads/sale-notifications/67890/proof_20240115_143000.pdf",
  • "file_name": "comprovante_venda.pdf",
  • "file_size": 1024000,
  • "file_type": "application/pdf",
  • "uploaded_at": "2024-01-15T14:30:00Z",
  • "message": "Arquivo de comprovação enviado com sucesso e processo concluído"
}

Download do arquivo de comprovação

Endpoint para fazer download do arquivo de comprovação de uma comunicação de venda específica. Retorna uma URL temporária (válida por 1 minuto) para download do arquivo armazenado no S3.

path Parameters
id
required
integer
Example: 67890

ID da comunicação de venda

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{}

Solictações de Sucatas

Endpoints relacionados a solicitações de sucata

Empresas

Lista de Empresas

Retorna a lista de empresas cadastradas.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/companies?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/companies?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/companies",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Custos do Bem

Custos por Bens

Neste endpoint podemos listar os custos extras que não podem ser registrados no documento de Repasse ou Venda do Bem.

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

with[]
Array of strings

Relacionado ao tipo de custo

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/assets-costs?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/assets-costs?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/assets-costs",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Criar Custos por Bens

Endpoint para cadastrar os custos extras que não podem ser registrados no documento de Repasse ou Venda do Bem.

Precisaremos registrar um dos tipos de custos já parametrizados no sistema (type_of_costs_id). Abaixo temos um endpoint em que podemos pesquisar os tipos de custo.

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
required
file
string <binary>

Anexo opcional

asset_id
required
integer

Id do veículo/bem

cost
required
number <float>

Custo para o veículo/bem

type_of_costs_id
required
integer

Id do tipo de custo

note
required
string

Número de nota

observation
string

Observação

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Recurso atualizado com sucesso!"
}

Tipos de custos

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/costs-per-assets-type?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/costs-per-assets-type?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/costs-per-assets-type",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Download de comprovante de custo

Endpoint para fazer download de comprovante de custo por ID do receipt.

Importante: O ID a ser utilizado é o ID do receipt que pode ser obtido na listagem de custos por bens passando o parâmetro with[]=receipts.

Para obter o ID do receipt:

  1. Faça uma requisição para /assets-costs?with[]=receipts
  2. Localize o custo desejado na resposta
  3. Use o ID do receipt encontrado no array receipts para fazer o download
path Parameters
id
required
integer
Example: 123

ID do receipt de custo (obtido através de with[]=receipts na listagem de custos)

query Parameters
client_id
required
string
Example: client_id=34aacec916f22ae521eab64f1ec959b5a4445132ag9f2685612g74ee756659cc

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=zqh02e967ffb7e1f0dedf785f2e8b20dfac30a9ca7s0964a78f139bfafcad331

Secret fornecido pelo Bradesco.

Responses

Upload de comprovante para o custo do bem

Endpoint para realizar um upload de comprovante relacionado ao custo do bem.

Ao realizar o upload do comprovante, há uma substituição do antigo comprovante por um novo, caso haja um comprovante já associado.

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

Request Body schema: multipart/form-data
required
file
required
string <binary>
assets_cost_id
required
integer

Id do custo do bem

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": 201,
  • "message": "Recurso criado!"
}

Edital e Catálogos

Download do documento de edital

Realiza o download do documento (edital) relacionado ao evento.

path Parameters
event_id
required
integer
Example: 123

ID do evento relacionado ao aviso de edital.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{}

Download do catálogo do evento

Realiza o download do catálogo de veículos do evento.

path Parameters
event_id
required
integer
Example: 123

ID do evento relacionado ao catálogo.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{}

Remover edital

Realiza a remoção do edital (documento) vinculado ao evento.

path Parameters
event_id
required
integer
Example: 123

ID do evento cujo documento de edital será removido.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Documento removido com sucesso!",
  • "status": 200,
  • "success": true
}

Remover catálogo do evento

Realiza a remoção do catálogo de veículos vinculado ao evento.

path Parameters
event_id
required
integer
Example: 123

ID do evento cujo catálogo será removido.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Catálogo removido com sucesso!",
  • "status": 200,
  • "success": true
}

Upload do documento do edital

Realiza o upload do documento do edital vinculado ao evento.

path Parameters
event_id
required
integer
Example: 123

ID do evento relacionado ao upload do documento do edital.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo a ser enviado (PDF, JPEG, JPG ou PNG).

Responses

Response samples

Content type
application/json
{
  • "message": "Documento enviado com sucesso.",
  • "status": 200,
  • "success": true
}

Upload do catálogo do evento

Realiza o upload do catálogo de veículos vinculado ao evento.

path Parameters
event_id
required
integer
Example: 123

ID do evento relacionado ao upload do catálogo.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo a ser enviado (PDF, JPEG, JPG ou PNG).

Responses

Response samples

Content type
application/json
{
  • "message": "Documento enviado com sucesso.",
  • "status": 200,
  • "success": true
}

Canais de Vendas

Canais de Vendas

Neste endpoint podemos listar todos os canais de vendas vinculados ao leiloeiro.

query Parameters
client_id
required
string

Id fornecido pelo Bradesco

secret_id
required
string

Secret fornecido pelo Bradesco

with[]
Array of strings

Relacionado ao canal de venda

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/sales-channels?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/sales-channels?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/sales-channels",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Criar canal de venda

Cria um novo canal de venda vinculado ao leiloeiro.

Request Body schema: application/json
required
name
required
string

Nome do canal de venda

sla
required
string

SLA do canal em quantidade de dias

Responses

Request samples

Content type
application/json
{
  • "name": "Canal XYZ",
  • "sla": "3"
}

Detalhar canal de venda

Retorna os dados de um canal de venda específico.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Canal XYZ",
  • "auctioneer_id": 1,
  • "sla": "2",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Atualizar canal de venda

Atualiza os dados de um canal de venda.

path Parameters
id
required
integer
Request Body schema: application/json
required
name
string

Nome do canal

sla
string

SLA do canal em quantidade de dias

Responses

Request samples

Content type
application/json
{
  • "name": "Canal Atualizado",
  • "sla": "5"
}

Remover canal de venda

Remove um canal de venda do sistema.

path Parameters
id
required
integer

Responses

Bens X Canais de Vendas

Lista vínculos entre bens e canais de venda

Lista os registros de bens associados a canais de venda.

query Parameters
client_id
required
string
secret_id
required
string

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "total": 0,
  • "per_page": 0,
  • "from": 0,
  • "to": 0
}

Criar vínculo entre bem e canal de venda

Request Body schema: application/json
required
asset_id
required
integer

ID do bem

sales_channel_id
required
integer

ID do canal

Responses

Request samples

Content type
application/json
{
  • "asset_id": 1276883,
  • "sales_channel_id": 1
}

Exibir vínculo específico

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "asset_id": 0,
  • "sales_channel_id": 0,
  • "client_id": "string",
  • "auctioneer_id": 0,
  • "status": "A_VENDA",
  • "sale_value": "200.00",
  • "sale_date": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "days_since_creation": 0
}

Atualizar dados do vínculo

Atualiza status e dados do comprador, respeitando regras de negócio.

path Parameters
id
required
integer
Request Body schema: application/json
required
status
string
Enum: "A_VENDA" "VENDIDO"

Atualizar o status do vínculo A_VENDA ou VENDIDO (Passe como VENDIDO para finalizar o processo)

name_client
string

Nome do cliente que comprou o bem

sale_value
number

Valor da venda

cpf
string

CPF do comprador

cnpj
string

CNPJ do comprador

Responses

Request samples

Content type
application/json
{
  • "status": "A_VENDA",
  • "name_client": "string",
  • "sale_value": 0,
  • "cpf": "string",
  • "cnpj": "string"
}

Remover vínculo entre bem e canal de venda

path Parameters
id
required
integer

Responses

Upload da nota de venda (sell note)

Faz upload da nota de venda associada ao bem.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo da nota (.pdf, .png, .jpg) — máx. 50MB

asset_id
required
integer

ID do bem (asset)

Responses

Upload do ATPV do bem

Faz upload do ATPV da venda.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Arquivo ATPV (.pdf, .png, .jpg) — máx. 50MB

asset_id
required
integer

ID do bem (asset)

Responses

Documento Repasse X Canais de Vendas

Upload do comprovente de repasse por canal de venda

Faz upload do comprovente de repasse da venda.

path Parameters
asset_sales_channels_id
required
integer

Passar como parâmetro o id do relacionamento entre canais de vendas e assets (assets-sales-channels)

Request Body schema: multipart/form-data
required
document
required
string <binary>

Arquivo Comprovante de Repasse (.pdf, .png, .jpg) — máx. 50MB

Responses

Lista de Documentos De Repasse (Canais de Vendas)

Obtém uma lista de documentos de repasse(Documento com as informações de valores a serem repassados para o banco do bem vendido), com base nos parâmetros fornecidos.

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

with[]
string
Example: with[]=asset

Parâmetro opcional para incluir dados relacionados, como eventos.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/transfer-receipts-channels?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/transfer-receipts-channels?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/transfer-receipts-channels",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Download do documento de repasse

Realiza o download do documento de repasse solicitado através do ID.

path Parameters
id
required
integer
Example: 1

ID do documento de repasse (transfer-receipts-channels.id)

query Parameters
client_id
required
string
Example: client_id=KJADS854FAAS

ID fornecido pelo Bradesco.

secret_id
required
string
Example: secret_id=8FHGRA86G3FW

Secret fornecido pelo Bradesco.

Responses

Response samples

Content type
application/json
{
  • "message": "Documento encontrado!",
  • "file": "link-cdn",
  • "status": 200,
  • "success": true
}

Manifestação pós-venda

Retorna a listagem de manifestações pós-venda.

Lista as manifestações de recompra ou ajustes de ativos no pós-venda.

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

search
string
Example: search=status:PENDENTE

Filtro para status ou resolução da manifestação.
Exemplos:

  • search=status:PENDENTE
  • search=status:PENDENTE_JUDICIAL
  • search=status:APROVADO
  • search=status:REPROVADO
  • search=resolution:RECOMPRA
  • search=resolution:DESCONTO
  • search=resolution:RESTRICAO_JUDICIAL

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/asset-repurchase?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/asset-repurchase?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/asset-repurchase",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 1,
  • "total": 1
}

Detalha uma recompra e inclui follow-ups e documentos

Retorna os detalhes de uma recompra pelo ID. É possível incluir os follow-ups e seus documentos usando with[]=followUps.followUpDocuments.

path Parameters
id
required
integer
Example: 5

ID da recompra

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

with[]
Array of strings
Items Value: "followUps.followUpDocuments"

Relações adicionais para carregar na resposta. Use with[]=followUps.followUpDocuments para trazer os follow-ups e seus documentos.

Responses

Response samples

Content type
application/json
{
  • "message": "Recurso encontrado",
  • "status": 200,
  • "data": {
    }
}

Cadastra uma manifestação pós-venda

Permite cadastrar uma manifestação de recompra ou ajuste no pós-venda. Quando um documento é enviado, os campos type_doc e observation se tornam obrigatórios.

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

Request Body schema: multipart/form-data
required
asset_id
required
integer

ID do Bem cadastrado.

document
string <binary>

Arquivo do documento (.pdf, .png, .jpeg, .jpg). Máximo de 50MB.

type_doc
string or null
Enum: "OUTROS" "SUSPEITA_ADULTERACAO_CHASSI" "SUSPEITA_ADULTERACAO_MOTOR" "SINISTRO_NA_ORIGEM" "DIVERGENCIA_DE_MONTA" "DIVERGENCIA_NA_DIVULGACAO" "RENAJUD"

Tipo do documento enviado (obrigatório se document for informado).

observation
string or null

Observação sobre o documento (obrigatória se document for informado).

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Recompra cadastrada com sucesso.",
  • "status": 200,
  • "success": "true"
}

Resposta manifestação pós-venda

Cadastrar follow-up de recompra

Permite registrar a resposta de uma manifestação pós-venda (follow-up). Quando um documento é enviado, o campo type_doc se torna relevante.

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

Request Body schema: multipart/form-data
required
repurchase_id
required
integer

ID da recompra existente.

observation
required
string

Observação sobre o follow-up.

status
string
Enum: "REPROVADO" "APROVADO" "PENDENTE_JUDICIAL" "PENDENTE"
document
string <binary>

Arquivo do documento (.pdf, .png, .jpeg, .jpg). Máximo de 50MB.

type_doc
string or null
Enum: "OUTROS" "SUSPEITA_ADULTERACAO_CHASSI" "SUSPEITA_ADULTERACAO_MOTOR" "SINISTRO_NA_ORIGEM" "DIVERGENCIA_DE_MONTA" "DIVERGENCIA_NA_DIVULGACAO" "RENAJUD"

Tipo do documento enviado (opcional).

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Follow-up de Recompra cadastrado com sucesso.",
  • "status": 200,
  • "success": true
}

Lista follow-ups de recompra

Retorna a listagem de follow-ups de recompra realizados pelo leiloeiro.

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

search
string

Filtro de busca (ex.: search=observation:'exemplo')

page
integer
Default: 1

Página da listagem.

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/repurchase-follow-up?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/repurchase-follow-up?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/repurchase-follow-up",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 3,
  • "total": 3
}

Detalha um follow-up de recompra

Retorna os detalhes de um follow-up de recompra específico pelo ID. É possível incluir os documentos do follow-up utilizando with[]=followUpDocuments.

path Parameters
id
required
integer
Example: 1

ID do follow-up de recompra

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

with[]
Array of strings
Items Value: "followUpDocuments"

Relações adicionais para carregar na resposta. Use with[]=followUpDocuments para trazer os documentos do follow-up.

Responses

Response samples

Content type
application/json
{
  • "message": "Recurso encontrado",
  • "status": 200,
  • "data": {
    }
}

Download do documento de follow-up de recompra

Retorna o documento enviado em um follow-up de recompra específico pelo ID.

path Parameters
id
required
integer
Example: 3

ID do documento do follow-up de recompra

query Parameters
client_id
required
string
Example: client_id=123456789

ID do cliente provido pelo Bradesco.

secret_id
required
string
Example: secret_id=abc123secret

Secret ID provido pelo Bradesco.

Responses

Response samples

Content type
application/json
{}

Solicitações de Sucata

Criar solicitação de sucata

Endpoint para criar uma nova solicitação de sucata para um ativo específico. É necessário informar o ativo, justificativa e pelo menos uma foto.

Request Body schema: multipart/form-data
required
asset_id
required
string

ID do ativo

justification
required
string

Justificativa da solicitação

photos
required
Array of strings <binary> [ items <binary > ]

Lista de fotos do ativo

Responses

Response samples

Content type
application/json
{
  • "status": 201,
  • "success": true,
  • "message": "Solicitação de sucata criada com sucesso",
  • "data": {
    }
}

Lista solicitações de baixa de sucata

Retorna a listagem paginada de solicitações de baixa de sucata com informações de grupos e ativos relacionados.

query Parameters
page
integer

Página da paginação

per_page
integer

Quantidade de registros por página

header Parameters
client_id
required
string
Example: cliente_teste_123

Identificador do cliente

secret_id
required
string
Example: secreto_456

Chave secreta do cliente

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/scrap-requests?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/scrap-requests?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/scrap-requests",
  • "per_page": 100,
  • "prev_page_url": null,
  • "to": 2,
  • "total": 2
}

Cadastrar autorização de cliente para compra de sucata. (FEATURE APENAS EM HOMOLOGAÇÃO)

Endpoint para cadastrar (ou atualizar) o documento de autorização de compra de sucata de um cliente. Caso o cliente ainda não exista, ele será criado automaticamente a partir dos dados enviados.

Request Body schema: multipart/form-data
required
document_type
required
string
Enum: "cpf" "cnpj"

Tipo de documento do cliente

document
required
string

Documento do cliente.

  • Se document_type = cpf, deve conter 11 dígitos.
  • Se document_type = cnpj, deve conter 14 dígitos.
file
required
string <binary>

Arquivo do documento de autorização (pdf, jpg, jpeg ou png) com até 5MB

document_validate_date
required
string <date>

Data de validade do documento de autorização

name_client
required
string

Nome do cliente

ddd_phone_1
required
string

DDD do telefone principal

phone_1
required
string

Telefone principal do cliente

ddd_phone_2
string or null

DDD do telefone secundário (opcional)

phone_2
string or null

Telefone secundário do cliente (opcional)

email
required
string <email>

E-mail do cliente

street_type
string or null

Tipo de logradouro (Rua, Avenida, etc.)

public_place
required
string

Logradouro

number
required
string

Número do endereço

district
required
string

Bairro

city
required
string

Cidade

state
required
string

Estado (UF) com 2 caracteres

cep
required
string

CEP do endereço

complement
required
string

Complemento do endereço

Responses

Response samples

Content type
application/json
{
  • "message": "Documento registrado.",
  • "status": 201,
  • "data": {
    }
}

Listar autorizações de clientes para compra de sucata. Cadastrar autorização de cliente para compra de sucata. (FEATURE APENAS EM HOMOLOGAÇÃO)

Retorna a listagem paginada de documentos de autorização de compra de sucata vinculados ao leiloeiro autenticado.

query Parameters
page
integer
Example: page=1

Página da paginação

per_page
integer
Example: per_page=15

Quantidade de registros por página

search
string
Example: search=client.cpf:12345678901

Filtro por CPF ou CNPJ do cliente (CPF filtrar client.cpf e CNPJ filtrar client.cnpj)

Responses

Response samples

Content type
application/json
{
  • "current_page": 1,
  • "data": [
    ],
  • "first_page_url": "/clients/scrap-authorization?page=1",
  • "from": 1,
  • "last_page": 1,
  • "last_page_url": "/clients/scrap-authorization?page=1",
  • "links": [
    ],
  • "next_page_url": null,
  • "path": "/clients/scrap-authorization",
  • "per_page": 15,
  • "prev_page_url": null,
  • "to": 10,
  • "total": 10
}

Download do documento de autorização de sucata. Cadastrar autorização de cliente para compra de sucata. (FEATURE APENAS EM HOMOLOGAÇÃO)

Gera uma URL temporária para download do documento de autorização de compra de sucata referente ao cliente vinculado ao leiloeiro autenticado.

path Parameters
id
required
integer
Example: 12

ID do documento de autorização

Responses

Response samples

Content type
application/json
{}