Documentação - API Despachante (1.0.0)

Download OpenAPI specification:

Processos

Endpoints relacionados aos processos.

Retorna a listagem de processos.

Lista todos os processos relacionados ao despachante.

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=dispatch_id:7 - filter=status:REGULARIZADO - filter=car_plate:ABC-1234 - filter=chassi:9BWZZZ377VT004251 - Filtro opcional para especificar o ID ou status dos processos. Passando o valor do parametro "filter" igual a "chave:valor", abaixo é apresentado os exemplos de filtros e status disponiveis: STATUS: EM_REGULARIZACAO REGULARIZADO PENDENTE_DOCUMENTACAO DOCUMENTACAO_OK CANCELADO

Responses

Response samples

200

Content type

application/json

[{"dispatch_id": 101,
"asset_id": 202,
"created_at": "2024-08-15T10:20:30.000000Z",
"updated_at": "2024-09-20T14:50:48.000000Z",
"finish_date": null,
"status": "PENDENTE",
"observation": "Verificar documentação pendente.",
"document": "documento.pdf",
"document_type": "CPF",
"complementary_documents": [{"id": 1,
"dispatch_id": 101,
"asset_id": 202,
"path": "bradesco_documents/Documento.pdf",
"created_at": "2024-08-15T10:20:30.000000Z",
"updated_at": "2024-09-20T14:50:48.000000Z",
"deleted_at": null,
"name": "Documento.pdf"
}
],
"high_debt": {"is_high_debit": false,
"status": "APROVADO"
},
"payment": {"attached_receipts": true,
"note_number": "NotaFiscal12345"
},
"reversion": {"is_reversion": false,
"person_type": null,
"proof_of_residence": null,
"social_contract": null,
"cnpj_document": null,
"rg": null,
"cpf": null,
"phone_number": null,
"email_address": null,
"court_order_property_transfer": null,
"vehicle_paid_off": null
},
"asset": {"name": "Gol 1.6",
"car_plate": "XYZ-9876",
"chassis": "9BGKS48R0FG123456",
"renavam": "12345678900",
"auctioneer": "Leiloeiro XYZ",
"advisory": "Assessoria ABC",
"bank": "Banco ABC",
"company": "Empresa XYZ",
"notes": "Veículo em bom estado.",
"is_judicial": false,
"category": "utilitário"
},
"debts": [{"id": 501,
"dispatch_id": 101,
"type": "Multa",
"amount": "150.00",
"year": 2023,
"created_at": "2024-08-15T10:25:30.000000Z",
"updated_at": "2024-08-15T10:25:30.000000Z",
"deleted_at": null
}
],
"pendencies": [{"id": 701,
"dispatch_id": 101,
"type": "Laudo ECV",
"reason": "Documento incompleto",
"document": "documentos/teste.pdf",
"observation": "Aguardando nova vistoria.",
"resolution_date": "2024-09-01",
"resolution": "Documento aprovado",
"status": "RESOLVIDO",
"created_at": "2024-08-15T10:30:30.000000Z",
"updated_at": "2024-08-15T10:45:30.000000Z",
"deleted_at": null,
"document_result": true
}
]
}
]

Finaliza um processo ativo.

Finaliza um processo ativo, desde que:

Não haja pendências ativas
Não haja débitos elevados pendentes de análise

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

dispatch_id required	integer ID do processo a ser finalizado.
document required	string <binary> Documento em PDF.
document_type required	string Tipo do documento a ser anexado ao processo. Tipos de Documentos Aceitos: CRLV REMARCACAO_DE_CHASSI REMARCACAO_DE_MOTOR BAIXA_SUCATA
transfer_document	string <binary> Documento de transferência (CRLV) - OPCIONAL Este campo é opcional e deve ser preenchido apenas quando o `document_type` for `BAIXA_SUCATA`. Deve conter o CRLV (Certificado de Registro e Licenciamento de Veículo) para comprovar a transferência do veículo.
observation	string Observação referente a finalização do processo.

Responses

Response samples

200
400
409
422

Content type

application/json

{"message": "Processo finalizado com sucesso."
}

Realiza a liberação antecipada de um processo ativo.

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

dispatch_id

required

integer

ID do processo a ser finalizado.

Responses

Response samples

200
400
422

Content type

application/json

{"message": "Processo Atualizado."
}

Faz upload de documentos complementares de regularização.

Realiza o upload de documentos complementares relacionados a um processo de regularização.

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

dispatch_id required	integer ID do processo ao qual os documentos serão anexados.
asset_id required	integer ID do asset ao qual os documentos serão anexados.
files required	Array of strings <binary> [ items <binary > ] Array de arquivos de documentos complementares.

Responses

Response samples

200
401

Content type

application/json

{"message": "Documento cadastrado com sucesso",
"data": [{"id": 123456789,
"asset_id": "123456789",
"dispatch_id": "123456789",
"name": "documento.pdf",
"path": "bradesco_documents/documento.pdf",
"created_at": "2025-06-13T12:35:24.000000Z",
"updated_at": "2025-06-13T12:35:24.000000Z"
}
]
}

Download de documento complementar de regularização.

Realiza o download de um documento complementar específico pelo ID.

path Parameters

id

required

integer

Example: 920

ID do documento complementar a ser baixado.

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

200
401
404

Content type

application/json

{"message": "Documento encontrado!",
"file": "https://link-do-documento.com/document.pdf"
}

Debitos

Endpoints relacionados aos Débitos.

Cria débitos para um processo.

Cria um item de débitos associado a um dispatch_id, verificando se já existe um registro semelhante.

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:
application/json
required

dispatch_id	integer O ID do processo.
type	string Tipo do débito. Valores possíveis: IPVA Multas Licenciamento Alteração de dados Atualização monetária Baixa al. fid./res. dom./arr. mercantil Baixa de alienação fiduciária Baixa de veículos Cancelamento de protesto Comunicado de venda Confecção de placa DARE DARF Deslocamento Emissão de CRLV Emissão de 2ª via do DUT/CRV Emissão de CRV com NF/CRV até 30 dias e CRLV atualizado Emissão de nada consta Estadia no pátio para veículos Gravame Guia de pagamento Histórico Honorários Honorários cobrança extra-judicial Inserção comunicado de venda Juros TRLAV Laudo de vistoria e decalque do veículo Mudança domicílio veículo Número de DUDA - 2ª via docto veículo CRV/CRLV Número de DUDA - Alteração dados veiculares Número de DUDA - Duas placas Mercosul p/ veíc. Número de DUDA - Emplacamento fora do local Número de DUDA - Inclusão/baixa financ. veíc. Número de DUDA - Transf. de prop. veíc. usado Ofício remarcação de chassi Par de placas Placa Mercosul Postagem do CRLV Primeiro emplacamento Registro de veículo Registro docto circulação internacional Restrição administrativa Segunda via CRLV Segunda via do registro de veículo Segunda via transferência Serviços bancários Taxa certificado propriedade Taxa de bombeiros Taxa de digitalização Taxa de remarcação chassi/motor Taxa de transferência Taxa DETRAN Taxa remoção de veículos Vistoria de veículo Vistoria veicular em trânsito
amount	number Valor do débito lançado.
year	integer Ano do débito lançado.

Responses

Request samples

Payload

Content type

application/json

{"dispatch_id": 7,
"type": "Multas",
"amount": 189.99,
"year": 2024
}

Response samples

201
400
409
422
500

Content type

application/json

{"message": "Débito criado.",
"data": {"dispatch_id": 7,
"type": "Multas",
"amount": 189.99,
"year": 2024
}
}

Listagem de débitos.

Retorna a listagem de débitos.

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=id:4 - filter=dispatch_id:7 - filter=bank_id:5 - Filtro opcional para especificar um Débito. Passando o valor do parametro "filtro" igual a "chave:valor", abaixo estão os exemplos de filtros disponiveis.

Responses

Response samples

200
400
404

Content type

application/json

[{"dispatch_id": 7,
"type": "Multas",
"amount": 189.99,
"year": 2024
}
]

Download do arquivo de comprovante de débitos.

Retorna o comprovante de débitos em formato PDF.

path Parameters

id

required

string

Example: 7

ID do comprovante de débito a ser baixado (gerado automaticamente pelo sistema).

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

200
404
422

Content type

application/json

{"message": "Documento Encontrado.",
"status": 200,
"file": "https://link-do-documento.com/document.pdf"
}

Faz o upload do arquivo de comprovante de débitos.

Faz o upload do arquivo de comprovante de débitos anexando ao processo pelo dispatch_id e débitos pelos 'debts_id'.

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

dispatch_id required	integer ID do processo ao qual o comprovante se refere.
document required	string <binary> Arquivo de comprovante em PDF ou imagem.
debt_ids required	Array of arrays IDs dos Débitos ao qual deseja realizar o relacionamento.

Responses

Response samples

200
400
422

Content type

application/json

{"message": "Comprovante de Débito cadastrado com sucesso!",
"status": 200,
"data": {"dispatch_id": 123,
"receipt_path": "https://link-do-documento.com/document.pdf",
"status": "PROCESSANDO",
"updated_at": "2025-06-13T12:35:24.000000Z",
"created_at": "2025-06-13T12:35:24.000000Z",
"id": 456,
"inconsistency": false,
"debts": [ ]
}
}

Contestar a análise que o OCR realizou entre o débito e o comprovante.

Encaminha o comprovante para o patrimonio realizar nova analise entre o débito e o comprovante.

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

receipt_id

required

integer

ID do Comprovante ao qual deseja realizar a contestação.

Responses

Response samples

200
404
422

Content type

application/json

{"message": "Comprovante encaminhado para analise.",
"status": 200,
"data": { }
}

Relaciona os débitos a um comprovante já inserido no sistema.

Endpoint para relacionar débitos e comprovantes existentes no sistema.

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

receipt_id required	integer ID do Comprovante ao qual deseja realizar o relacionamento.
debt_ids	Array of arrays ID dos Débitos ao qual deseja realizar o relacionamento.

Responses

Response samples

200
404

Content type

application/json

{"message": "Comprovantes Anexados com sucesso.",
"status": 200,
"data": { }
}

Deleta um débito.

Deleta um débito a partir do ID.

path Parameters

id

required

integer

Example: 7

ID do débito a ser deletado

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

404
409

Content type

application/json

{"message": "Débito não encontrado"
}

Listagem de comprovantes de débito pendentes de análise.

Retorna a listagem de comprovantes de débito que não estão com status 'PROCESSANDO', com filtros opcionais.

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=id:7 - filter=dispatch_id:7 - filter=status:APROVADO - Filtro opcional para especificar parâmetros dos comprovantes de débito (ex: id, dispatch_id, status, etc). Use o formato chave:valor.

Responses

Response samples

200
400
404

Content type

application/json

{"current_page": 1,
"data": [{"id": 123,
"dispatch_id": 7,
"status": "APROVADO",
"receipt_path": "https://link-do-documento.com/document.pdf",
"created_at": "2025-06-13T12:35:24.000000Z",
"updated_at": "2025-06-13T12:35:24.000000Z"
}
],
"first_page_url": "/api/dispatcher-api/v1/debts/receipts/pending-analysis?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "/api/dispatcher-api/v1/debts/receipts/pending-analysis?page=1",
"next_page_url": null,
"path": "/api/dispatcher-api/v1/debts/receipts/pending-analysis",
"per_page": 50,
"prev_page_url": null,
"to": 10,
"total": 10
}

Pendencias

Endpoints relacionados as Pendencias do processo.

Cria pendências.

Cria uma pendência, sempre relacionada a um processo passando o dispatch_id.

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

dispatch_id	integer O ID do processo relacionado à pendência.
type	string Tipo da Pendência. Aceita os seguintes valores: ECV Bloqueio Documentação pendente Restrição administrativa Gravame expirado Outras pendências Autorização de baixa de sucata Comprovante de residência incorreto Dados de contato incorreto
reason	string (Opcional) Motivo da pendência. Se não for fornecido, será preenchido automaticamente com o valor do tipo. ECV: `Regularização de motor`, `ECV pendente`, `Suspeita de adulteração` Bloqueio: `Diversos`, `Revistoria`, `Judicial` Restrição administrativa: `Comunicado de venda`, `Média monta`, `Pendência de emplacamento`, `Recall`, `ATPV-E`, `Transferência de jurisdição`, `Restrição de débito na origem`, `Segunda via`, `Processo pendente em aberto no detran` Documentação pendente: `Comprovante de residência`, `Nota fiscal`, `Sentença`, `Documento de retomada`, `Outros documentos`, `Documentos do financiado` Gravame expirado: `Outras UFs`, `UFs RS/GO/DF/SC` Outras pendências: `Diversos`
observation	string Observação referente à pendência.
document	string <binary> Arquivo relacionado à pendência. Aceita arquivos PDF, DOC, DOCX, PNG, JPG, JPEG de até 50MB.

Responses

Response samples

201

Content type

application/json

{"id": 1,
"dispatch_id": 7,
"type": "Laudo ECV",
"document": "https://link-do-documento.com/document.pdf",
"observation": "Pendência devido à falta de laudo ECV"
}

Retorna uma listagem de pendências.

Retorna as pendências relacionadas a um processo.

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=dispatch_id:7 - filter=status:EM_ANALISE - Filtro opcional para especificar o ID do Processo ou status da pendência. Passando o valor do parâmetro "filter" igual a "chave:valor", abaixo é apresentado os exemplos de filtros e status disponíveis: STATUS: EM_ANALISE RESOLVIDO

Responses

Response samples

200
400
404

Content type

application/json

[{"id": 1,
"dispatch_id": 7,
"type": "Laudo ECV",
"reason": "Faltando",
"document": null,
"observation": "Pendência devido a falta de laudo ECV.",
"resolution_date": "2024-10-09",
"resolution": "BAIXA_DE_SUCATA",
"status": "RESOLVIDO",
"document_result": "https://link-do-documento.com/document.pdf"
}
]

Atualiza o status de uma pendência.

path Parameters

id

required

string

Example: 7

ID da pendência a ser atualizada.

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

status

string

Status da pendência. Aceita os seguintes valores:

EM_ANALISE
RESOLVIDO

Responses

Response samples

200
404

Content type

application/json

{"message": "Recurso Atualizado!"
}

Pagamentos

Endpoints relacionados aos Pagamentos.

Listagem dos pagamentos.

Retorna a listagem dos pagamentos.

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=group_id:7 - filter=number:18 - Filtro opcional para especificar o ID do Agrupamento ou número da nota. Passando o valor do parametro "filter" igual a "chave:valor", abaixo é apresentado os exemplos de filtros:

Responses

Response samples

200
400

Content type

application/json

[{"group_id": 7,
"bank_name": "Bradesco SA",
"total_cost": "318.03",
"start_date": "2024-04-09",
"end_date": "2024-10-03",
"number": 4,
"document_assigned": true
}
]

Cria uma agrupamento de débitos com o número do recibo.

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

debt_ids

Array of arrays

ID dos Débitos ao qual deseja realizar o relacionamento.

Responses

Response samples

200
422

Content type

application/json

{"message": "Comprovantes Anexados com sucesso.",
"status": 200,
"data": { }
}

Gera o documento de Recibo Para Pagamento.

Gera o documento em PDF de Recibo Para Pagamento pelo group_id em branco para assinar.

path Parameters

group_id

required

string

Example: 7

ID do grupo de pagamentos para o qual o recibo deve ser gerado.

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

404

Content type

application/json

{"message": "Nenhum dado encontrado!"
}

Upload do documento de Recibo Para Pagamento.

Realiza o upload do documento de Recibo para Pagamentos, usando o group_id para identificar o grupo de pagamento.

path Parameters

group_id

required

string

Example: 7

ID do grupo de pagamentos para o qual o recibo deve ser enviado.

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

document

string <binary>

Arquivo de recibo a ser enviado. Regras de validação:

Obrigatório: Sim
Formatos permitidos: PDF, PNG, JPEG, JPG
Tamanho máximo: 50 MB (51,200 KB)

Responses

Response samples

200
404

Content type

application/json

{"message": "Documento importado com sucesso!"
}

Download do documento de Recibo Para Pagamento assinado.

Retorna o documento de Recibo Para Pagamento assinado pelo group_id.

path Parameters

group_id

required

string

Example: 7

ID do grupo de pagamentos para o qual o recibo deve ser baixado.

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

200
404

Content type

application/json

{"message": "Documento encontrado!",
"file": "https://link-do-documento.com/documento-assinado.pdf",
"status": 200,
"success": true
}

Adiciona o número do recibo ao grupo de pagamentos.

path Parameters

id

required

string

Example: 7

ID do grupo de pagamentos ao qual o recibo deve ser adicionado.

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: application/json
required

receipt_number

number

Número do recibo a ser adicionado.

Responses

Request samples

Payload

Content type

application/json

{"receipt_number": 123456789
}

Response samples

200
404

Content type

application/json

{"message": "Número de recibo adicionado com sucesso."
}

Desassocia registros de um agrupamento de pagamentos.

Remove dívidas (Reembolso ou Honorários) associadas a um agrupamento de pagamentos específico, identificado por group_id.

path Parameters

group_id

required

integer

Example: 19

ID do agrupamento de pagamentos a ser atualizado.

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: application/json
required

debt_ids

Array of integers

IDs das dívidas a serem desassociadas do agrupamento.

Responses

Request samples

Payload

Content type

application/json

{"debt_ids": [285
]
}

Response samples

200
400
404

Content type

application/json

{"message": "Débitos desvinculados e valores recalculados com sucesso.",
"data": { }
}

Bradesco Seguros

Endpoints relacionados aos Processos do Bradesco Seguros.

Inicia um processo do Bradesco Seguros.

Faz o upload do arquivo de anexando a placa que sera .

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

car_plate required	string Placa do veiculo a qual o processo será inciado.
documents required	string <binary> Arquivo de comprovante em PDF.

Responses

Response samples

200
400
409
422
500

Content type

application/json

{"plate": "ABC-1234",
"message": "Processo criado com sucesso"
}

Inicia um processo do Bradesco Seguros para sucatas.

Faz o upload do arquivo de anexando a placa que sera .

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

car_plate required	string Placa do veiculo a qual o processo será inciado.
renavam required	string Renavam do veiculo a qual o processo será inciado.
documents required	string <binary> Arquivo de comprovante em PDF.

Responses

Response samples

200
400
422

Content type

application/json

{"plate": "ABC-1234",
"message": "Processo criado 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=dispatch_id:7 - filter=car_plate:ABC-1234 - filter=chassi:9BWZZZ377VT004251 - Filtro opcional para especificar o ID do processo ou placa do veiculo. Passando o valor do parametro "filter" igual a "chave:valor".

Responses

Response samples

200

Content type

application/json

[{"dispatch_id": 1,
"document_id": 2,
"document_type": "ATPV",
"car_plate": "ABC-1234",
"chassis": "A1B2C3D4E5F6G7H8",
"asset_id": 4,
"file_url": "LINK TEMPORARIO PARA DOWNLOAD DO ARQUIVO"
}
]

Laudos

Endpoints relacionados aos Laudos do Bem.

Retorna a listagem de Laudos relacionados ao Bem.

Lista os Laudos 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=dispatch_id:7 - filter=car_plate:ABC-1234 - Filtro opcional para especificar o ID do processo ou placa do veiculo. Passando o valor do parametro "filter" igual a "chave:valor".

Responses

Response samples

200

Content type

application/json

[{"dispatch_id": 1,
"report_id": 2,
"report_type": "ECV",
"report_status": "APROVADO",
"car_plate": "ABC-1234",
"chassis": "A1B2C3D4E5F6G7H8",
"asset_id": 4,
"file_url": "LINK TEMPORARIO PARA DOWNLOAD DO ARQUIVO"
}
]

Comunicação de Venda

Endpoints relacionados a comunicação de venda.

Listar comunicações de venda

Endpoint para listar comunicações de venda recebidas do leiloeiro com filtros avançados por status e relacionamentos. Permite filtrar por múltiplos status simultaneamente e incluir dados relacionados como leiloeiro e 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.
with[]	Array of strings Items Enum: "auctioneer" "asset" Example: with[]=auctioneer&with[]=asset Relacionamentos adicionais a serem carregados. Valores aceitos: `auctioneer`, `asset`
searchOr	string Example: searchOr=status:ENVIADO AO DESPACHANTE;status:RECEBIDO PELO DESPACHANTE;status:PROCESSADO Filtro de busca com operador OR para múltiplos valores. Formato: `campo:valor1;campo:valor2;campo:valor3` Exemplo para filtrar por status: `status:ENVIADO AO DESPACHANTE;status:RECEBIDO PELO DESPACHANTE;status:PROCESSADO`
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

200
400
401
500

Content type

application/json

{"data": [{"id": 67890,
"asset_id": 12345,
"status": "ENVIADO AO DESPACHANTE",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:30:00Z",
"sent_at": "2024-01-15T14:30:00Z",
"received_at": "2024-01-15T15:00:00Z",
"auctioneer": {"id": 1,
"name": "Leiloeiro ABC"
},
"asset": {"id": 12345,
"car_plate": "AAA-9999",
"chassis": "9BWZZZZZZZZZZZZZZ",
"brand": "Toyota",
"model": "Corolla"
}
}
],
"meta": {"total": 150,
"per_page": 20,
"current_page": 1,
"last_page": 8
}
}

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=123456789 ID do cliente provido pelo Bradesco.
secret_id required	string Example: secret_id=abc123secret Secret ID provido pelo Bradesco.

Responses

Response samples

200
401
404
500

Content type

application/json

{"message": "Documento encontrado!",
"file": "https://bradesco-homolog-api.s3.amazonaws.com/sale-notifications/67890/proof_20240115_143000.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...",
"status": 200,
"success": true
}

Marcar comunicação como recebida

Endpoint para marcar uma comunicação de venda como recebida pelo despachante. Atualiza o status da comunicação para "RECEBIDO PELO DESPACHANTE" e registra a data de recebimento.

path Parameters

id

required

integer

Example: 67890

ID da comunicação de 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.

Responses

Response samples

Content type

application/json

{"id": 67890,
"status": "RECEBIDO PELO DESPACHANTE",
"received_at": "2024-01-15T15:00:00Z",
"message": "Comunicação de venda marcada como recebida 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. O tipo define se é uma comprovação de comunicação ou pesquisa.

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=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

proof_file_path required	string <binary> Arquivo de comprovação (PDF, JPG, JPEG, PNG, TXT) - máximo 20MB
type required	string Enum: "COMUNICACAO" "PESQUISA" Tipo do arquivo de comprovação

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",
"type": "COMUNICACAO",
"uploaded_at": "2024-01-15T14:30:00Z",
"message": "Arquivo de comprovação enviado com sucesso"
}

Honorários

Listagem de Honorários.

Retorna a listagem de honorários com filtros opcionais.

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=id:7 - filter=bank_id:5 - Filtro opcional no formato chave:valor (e.g., id:7, bank_id:5).

Responses

Response samples

200

Content type

application/json

{"message": "Honorários encontrados com sucesso.",
"status": 200,
"data": {"current_page": 1,
"data": [{"id": 30,
"created_at": "2024-12-19T22:36:50.000000Z",
"updated_at": "2024-12-21T18:29:38.000000Z",
"deleted_at": null,
"name": "HONORARIO_TRANSFERÊNCIA",
"dispatch_id": 4815,
"amount": "123.00",
"receipts_id": null,
"payment_group_id": 27,
"costs_per_assets_type_id": 5,
"status_ocr": "NAO_ANALISADO",
"bank_id": "6"
}
],
"first_page_url": "/api/dispatcher-api/v1/honoraries?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "/api/dispatcher-api/v1/honoraries?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"next_page_url": null,
"path": "/api/dispatcher-api/v1/honoraries",
"per_page": 50,
"prev_page_url": null,
"to": 16,
"total": 16
}
}

Pagamentos de Honorários

Listagem de Grupos de Pagamento de Honorários.

Retorna os grupos de pagamento de honorários com filtros opcionais.

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 Filtro opcional no formato chave:valor (e.g., group_id:7).

Responses

Response samples

200

Content type

application/json

{"current_page": 1,
"data": [{"id": 1,
"group_id": 1,
"bank_name": "BRADESCO AUTO RE",
"total_cost": "220.00",
"start_date": "2024-07-22",
"end_date": "2024-07-22",
"number": 12333,
"status": "APROVADO",
"bank_id": 4,
"provider": { },
"inconsistency": false,
"bank": {"id": 4,
"code": "5444",
"name": "BRADESCO AUTO RE",
"agency": "1",
"account": "3",
"transfer_type": "Depósito em conta",
"created_at": "2024-04-01T15:59:39.000000Z",
"updated_at": "2024-04-01T15:59:39.000000Z",
"days_to_regularize": 0,
"gran_code": null
},
"honoraries": [{"id": 30,
"created_at": "2024-12-19T22:36:50.000000Z",
"updated_at": "2024-12-21T18:29:38.000000Z",
"name": "HONORARIO_TRANSFERÊNCIA",
"dispatch_id": 4815,
"amount": "123.00",
"receipts_id": null,
"payment_group_id": 27,
"costs_per_assets_type_id": 5,
"status_ocr": "NAO_ANALISADO"
}
]
}
],
"first_page_url": "/api/dispatcher-api/v1/payments-honorary?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "/api/dispatcher-api/v1/payments-honorary?page=1",
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"next_page_url": null,
"path": "/api/dispatcher-api/v1/payments-honorary",
"per_page": 50,
"prev_page_url": null,
"to": 26,
"total": 26
}

Agrupamento de Honorários.

Cria um agrupamento de honorários com base nos dados fornecidos.

Request Body schema: application/json
required

honorary_ids

Array of integers

IDs dos honorários a serem agrupados.

Responses

Request samples

Payload

Content type

application/json

{"honorary_ids": [7,
12,
32
]
}

Response samples

201

Content type

application/json

{"message": "Recursos criados",
"data": [{"id": 27,
"group_type": "HONORARIO",
"provider_type": "DISPATCHER",
"provider_id": 2,
"bank_id": "6",
"number": "5",
"total_cost": 502,
"start_date": "2024-12-19",
"end_date": "2024-12-20",
"approved": 1,
"status": "PENDENTE",
"created_at": "2024-12-21T18:29:38.000000Z",
"updated_at": "2024-12-21T18:29:38.000000Z",
"provider": {"id": 2,
"name": "Despachante 1",
"contact_name": "Despachante 1",
"phone": "(13) 4444-4444",
"email": "despachante1@exemplo.com",
"created_at": "2024-05-27T20:10:12.000000Z",
"updated_at": "2024-05-27T20:10:12.000000Z",
"deleted_at": null,
"street": "Rua Murutu",
"number": "33",
"complement": null,
"city": "Guarulhos",
"state": "SP",
"cep": "07243-150",
"number_contract": null,
"center": null,
"cost_center": null,
"localization": null,
"contract_item": null,
"cnpj": null,
"client_id": "TST01",
"secret_id": "TST01"
},
"inconsistency": false
}
]
}

Upload de Nota de Honorários.

Realiza o upload de uma nota de honorários para o grupo especificado.

path Parameters

group_id

required

integer

ID do grupo.

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

document	string <binary> Arquivo da nota de honorários.
number_note	string Número da nota de honorários.

Responses

Download de Nota de Honorários.

Realiza o download de uma nota de honorários para o grupo especificado.

path Parameters

group_id

required

integer

ID do grupo.

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

200
404

Content type

application/json

{"message": "Documento encontrado!",
"file": "document-payment-group/PZzpTbC33DFJdWTQkSxE6HnQRzTBpf2uszsSSxtB.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAYZYK2LFHX24HGCPO%2F20241222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20241222T183042Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Signature=172f789cc3483904bd7ec7aa5de2b701c5fc57ec0704b6a8b8528f1632736343",
"status": 200,
"success": true
}

Documentação - API Despachante (1.0.0)

Processos

Retorna a listagem de processos.

query Parameters

Responses

Response samples

Finaliza um processo ativo.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Realiza a liberação antecipada de um processo ativo.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Faz upload de documentos complementares de regularização.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Download de documento complementar de regularização.

path Parameters

query Parameters

Responses

Response samples

Debitos

Cria débitos para um processo.

query Parameters

Request Body schema: application/jsonapplication/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Responses

Request samples

Response samples

Listagem de débitos.

query Parameters

Responses

Response samples

Download do arquivo de comprovante de débitos.

path Parameters

query Parameters

Responses

Response samples

Faz o upload do arquivo de comprovante de débitos.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Contestar a análise que o OCR realizou entre o débito e o comprovante.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Relaciona os débitos a um comprovante já inserido no sistema.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Deleta um débito.

path Parameters

query Parameters

Responses

Response samples

Listagem de comprovantes de débito pendentes de análise.

query Parameters

Responses

Response samples

Pendencias

Cria pendências.

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Retorna uma listagem de pendências.

query Parameters

Responses

Response samples

Atualiza o status de uma pendência.

path Parameters

query Parameters

Request Body schema: multipart/form-datarequired

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema:
application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required