Ir para o conteúdo
Método URL
DELETE https://BASE_URL/public/v1/recebiveis/titulos/{id}/documentos/{idLastro}

Desvincula um documento adicional do título — por exemplo, um contrato anexado ao título errado. O documento continua existindo e segue nos outros títulos que o usam (contrato mestre compartilhado).

Path Params

Campo Tipo Descrição
id Número Identificador do título.
idLastro Número Identificador do documento adicional, obtido em Listar Documentos do Título.

Esta rota não possui Request Body.

Exemplo de cURL
curl -X DELETE "https://BASE_URL/public/v1/recebiveis/titulos/551203/documentos/98231" \
  -H "Authorization: Bearer {token}" \
  -H "GrupoEconomico: {grupo}"
Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "Documento desvinculado do título."
}

Erros

Erros retornam o envelope RetornoPadrao.

HTTP Quando
400 Bad Request O documento é o lastro principal do título, ou já foi enviado (ou está em envio) à administradora.
404 Not Found O título não existe ou o documento não está vinculado a ele.
Response Body — 400 Bad Request (lastro principal)
{
  "status": "erro",
  "mensagem": "O documento principal do título (nota fiscal) não pode ser desvinculado."
}
Response Body — 400 Bad Request (documento já enviado)
{
  "status": "erro",
  "mensagem": "Documento já enviado (ou em envio) à administradora; não pode ser desvinculado."
}

Modelo de dados

Retorno

Campo Tipo Descrição
status Texto Status do processamento.
mensagem Texto Mensagem retornada pela API.

Observações

  • O principal não sai: para trocar o documento fiscal, envie o novo arquivo com tipoDocumento fiscal em Anexar Documento a Títulos — ele substitui o anterior.
  • O que já foi ao fundo, fica: documento com statusEnvioAdministradora EnviadoComSucesso ou Enviando não se desvincula, para o título não perder o que a administradora já recebeu.
  • Reanexar depois: um documento desvinculado pode ser anexado de novo ao mesmo título.