Ir para o conteúdo
Método URL
POST https://BASE_URL/public/v1/recebiveis/lotes/{idOperacao}/titulos/avulsos

Importa um ou mais títulos diretamente na operação informada, sem vínculo a um lote. Útil quando há a necessidade de registrar títulos sem que eles passem pelo fluxo de cessão em lote — por exemplo, para uma carga ou complementação na operação. Os títulos são criados em definitivo no cadastro do cedente após as validações de cedente, sacado e lastro. Em caso de sucesso, o retorno traz o identificador (id) da entidade título e os dados básicos de cada título criado.

Path Params

Campo Tipo Descrição
idOperacao Número Identificador da operação fornecido pela Vertrau.
Request Body
{
  "cedente": {
    "tipoPessoa": 2,
    "cpfCnpj": "12345678000195"
  },
  "titulos": [
    {
      "numeroControleParticipante": "0001",
      "numeroDocumento": "12345",
      "nossoNumero": "00012345",
      "codigoOriginador": "ORIGINADOR-123",
      "dataEmissao": "2024-11-28",
      "dataVencimento": "2024-12-28",
      "valorNominal": 1000.5,
      "valorAquisicao": 900.78,
      "bancoCobranca": 123,
      "agenciaDepositaria": 4567,
      "especie": "DM",
      "jurosMoraDiaAtraso": 0.5,
      "valorAbatimento": 20,
      "valorDesconto": 15.5,
      "tags": ["CC01", "RATING_A"],
      "sacado": {
        "tipoPessoa": 2,
        "cpfCnpj": "12345678000195",
        "nome": "Sacado I",
        "cep": "12345678",
        "endereco": "Rua dos Sacados, 1000",
        "cidade": "Blumenau",
        "uf": "SC",
        "email": "financeiro@sacado.com.br",
        "telefone": "47999990000",
        "numero": 1000,
        "bairro": "Centro",
        "complemento": "Sala 1"
      },
      "lastro": {
        "numeroNotaFiscal": 123456789,
        "numeroSerieNotaFiscal": 1,
        "chaveNfe": "12345678901234567890123456789012345678901234",
        "chaveAcessoNfe": "",
        "inscricaoMunicipal": "",
        "codigoMunicipioIBGE": "4202404",
        "dataEmissao": "2024-11-28",
        "valorTotal": 1000.5,
        "tipoLastroPerformado": "BP",
        "quantidadeParcelas": 1
      }
    }
  ]
}
Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "1 título(s) processado(s): 1 Criado.",
  "titulosIncluidos": [
    {
      "id": 2001,
      "situacao": "Criado",
      "numeroControleParticipante": "0001",
      "numeroDocumento": "12345",
      "dataEmissao": "2024-11-28",
      "dataVencimento": "2024-12-28",
      "valorNominal": 1000.5,
      "valorAquisicao": 900.78,
      "bancoCobranca": 123,
      "agenciaCobranca": 4567,
      "especie": "Duplicata",
      "jurosMoraDiaAtraso": 0.5,
      "valorAbatimento": 20,
      "valorDesconto": 15.5,
      "tags": ["CC01", "RATING_A"],
      "sacado": {
        "tipoPessoa": 2,
        "cpfCnpj": "12345678000195",
        "nome": "Sacado I",
        "cep": "12345678",
        "endereco": "Rua dos Sacados, 1000",
        "cidade": "Blumenau",
        "uf": "Santa Catarina (SC)",
        "email": "financeiro@sacado.com.br",
        "telefone": "47999990000",
        "numero": 1000,
        "bairro": "Centro",
        "complemento": "Sala 1"
      },
      "lastro": {
        "numeroNotaFiscal": 123456789,
        "numeroSerieNotaFiscal": 1,
        "chaveNfe": "12345678901234567890123456789012345678901234",
        "chaveAcessoNfe": "",
        "inscricaoMunicipal": "",
        "codigoMunicipioIBGE": "",
        "dataEmissao": "2024-11-28",
        "valorTotal": 1000.5,
        "tipoLastroPerformado": "Bens performado",
        "quantidadeParcelas": 1,
        "chaveCte": null,
        "chave": null
      }
    }
  ],
  "titulosNaoIncluidos": []
}
Response Body — 200 OK (nenhum título incluído)
{
  "status": "sucesso",
  "mensagem": "Nenhum título processado. 1 título(s) não incluído(s).",
  "titulosIncluidos": [],
  "titulosNaoIncluidos": [
    {
      "numeroControleParticipante": "",
      "numeroDocumento": "12345",
      "dataEmissao": "2024-11-28",
      "dataVencimento": "2024-10-28",
      "valorNominal": 1000.5,
      "especie": "Duplicata",
      "documentoSacado": "12345678000195",
      "motivo": "Título vencido. Operação não permite importação de títulos com data de vencimento anterior à data atual."
    }
  ]
}
Response Body — 400 Bad Request (lastro obrigatório)
{
  "status": "erro",
  "mensagem": "Erro ao importar títulos avulsos.",
  "titulosIncluidos": [],
  "titulosNaoIncluidos": [
    {
      "numeroControleParticipante": "",
      "numeroDocumento": "12345",
      "dataEmissao": "2024-11-28",
      "dataVencimento": "2024-12-28",
      "valorNominal": 1000.5,
      "especie": "Duplicata",
      "documentoSacado": null,
      "motivo": "As informações de lastro são obrigatórias."
    }
  ]
}

Modelo de dados

Requisição

Campo Tipo Descrição
cedente Cedente Dados do cedente proprietário dos títulos.
titulos Lista de Título Lista de títulos a serem importados na operação.

Cedente

Campo Tipo Descrição
tipoPessoa Número 1 = Pessoa Física, 2 = Pessoa Jurídica.
cpfCnpj Texto Documento do cedente, somente números. O cedente precisa estar previamente vinculado à operação informada.

Título

Campo Tipo Descrição
numeroControleParticipante Texto Número de controle do participante.
numeroDocumento Texto Número do documento.
nossoNumero Texto Nosso número do boleto. Campo opcional.
codigoOriginador Texto Código do originador do título. Campo opcional.
dataEmissao Data Data de emissão do título.
dataVencimento Data Data de vencimento do título.
valorNominal Decimal Valor original do título.
valorAquisicao Decimal Valor de aquisição do título.
bancoCobranca Número Código do banco responsável pela cobrança. Campo opcional.
agenciaDepositaria Número Agência depositária do banco de cobrança. Campo opcional.
especie Texto ou Número Espécie do título. Aceita a sigla ou o código numérico. Ver Espécies de título.
jurosMoraDiaAtraso Decimal Juros aplicados por dia de atraso.
valorAbatimento Decimal Valor de abatimento do título.
valorDesconto Decimal Valor de desconto concedido no título. Campo opcional; quando omitido, o título é gravado sem desconto. Não pode ser negativo nem superior ao valorNominal.
tags Lista de texto Tags associadas ao título.
sacado Sacado Dados do pagador.
lastro Lastro Dados do lastro do título. Obrigatório, exceto para as espécies CCB e UR.

Espécies de título

Informe a sigla ou o código numérico no campo especie. Ambas as formas são aceitas.

Sigla Código numérico Espécie
DM 2 Duplicata Mercantil
UR 3 Unidade de Recebível
NFSE 4 Nota Fiscal de Serviço
ND 5 Nota de Débito
CCB 6 CCB Pré Digital
NP 8 Nota Promissória
NC 9 Nota Comercial
CT 10 Contrato
NF 11 Nota Fiscal
CPR 12 Cédula de Produto Rural
CTE 13 CT-e
CD 14 Confissão de Dívida
AD 15 Assunção de Dívida
FCC 16 Fatura de Cartão de Crédito
BAP 17 Bloqueio Agenda Pagamento Cartão
DS 18 Duplicata de Serviço

Espécies de cartão: FCC e BAP cobrem os recebíveis de cartão que chegam pelo arquivo de estoque diário — respectivamente a fatura de cartão de crédito e o bloqueio de agenda de pagamento com baixa automática. Como qualquer espécie fora de CCB e UR, ambas exigem o objeto lastro.

Sacado

Campo Tipo Descrição
tipoPessoa Número 1 = Pessoa Física, 2 = Pessoa Jurídica.
cpfCnpj Texto Documento do sacado, somente números.
nome Texto Nome do sacado.
cep Texto CEP do endereço.
endereco Texto Endereço do sacado.
cidade Texto Cidade do sacado.
uf Texto Unidade federativa do sacado.
email Texto E-mail do sacado. Campo opcional.
telefone Texto Telefone do sacado. Campo opcional.
numero Número Número do endereço. Campo opcional.
bairro Texto Bairro. Campo opcional.
complemento Texto Complemento do endereço. Campo opcional.

Lastro

Campo Tipo Descrição
numeroNotaFiscal Número Número da nota fiscal. Campo opcional.
numeroSerieNotaFiscal Número Número de série da nota fiscal. Campo opcional.
chaveNfe Texto Chave de 44 dígitos da NF-e (modelo 55) ou do CT-e (modelo 57 ou 67). Quando a chave pertence a um CT-e válido, o sistema a reconhece automaticamente e vincula o título a um lastro de CT-e já existente (por exemplo, criado pelo upload do XML), evitando duplicidade.
chaveAcessoNfe Texto Chave de acesso da NF-e. Campo opcional.
inscricaoMunicipal Texto Inscrição municipal. Campo opcional.
codigoMunicipioIBGE Texto Código do município segundo o IBGE. Campo opcional.
dataEmissao Data Data de emissão da nota fiscal.
valorTotal Decimal Valor total da nota fiscal.
tipoLastroPerformado Texto ou Número Tipo do lastro performado. Aceita o código em string ou numérico: SN ou 0, SP ou 1, BN ou 2, BP ou 3, MN ou 4, MP ou 5 (ver Adicionar Títulos na seção de Cessão de Direitos Creditórios).
quantidadeParcelas Número Quantidade de parcelas vinculadas ao lastro. Campo opcional.
chave Texto Chave livre de identificação do lastro, definida por você (máximo de 100 caracteres). Campo opcional. Agrupa títulos no mesmo lastro e permite anexar o arquivo depois, em Anexar Lastro Avulso por Chave. Ver Agrupando títulos pelo mesmo lastro em Adicionar Títulos.

Retorno

O 200 OK traz em titulosIncluidos os títulos processados — cada um com o identificador da entidade título (id) e a sua situacao — e em titulosNaoIncluidos os títulos recusados nas validações, com o motivo. A importação é parcial: os títulos válidos são gravados mesmo quando outros são recusados. Se todos os títulos forem recusados, a resposta continua sendo 200 OK, com titulosIncluidos vazia.

O 400 Bad Request fica para a recusa da requisição inteira, antes de qualquer gravação. Ver Respostas de erro.

Sucesso (200 OK)

Campo Tipo Descrição
status Texto Sempre "sucesso".
mensagem Texto Resumo do processamento. Ver Mensagens de sucesso.
titulosIncluidos Lista de Título criado Títulos processados na operação.
titulosNaoIncluidos Lista de Título não incluído Títulos recusados nas validações, com o respectivo motivo.

Mensagens de sucesso

Situação mensagem
Todos os títulos processados {n} título(s) processado(s): {quantidade} {situação}. — por exemplo, 2 título(s) processado(s): 1 Criado, 1 Atualizado.
Parte dos títulos recusada A mensagem acima seguida de {m} título(s) não incluído(s).
Todos os títulos recusados Nenhum título processado. {m} título(s) não incluído(s).

Título criado

Campo Tipo Descrição
id Número Identificador da entidade título criada. Utilize-o nas operações subsequentes (ex.: exclusão — ver Excluir Títulos Avulsos).
situacao Texto "Criado", "Atualizado" ou "Não atualizado (título já movimentado pelo fundo)".
numeroControleParticipante Texto Número de controle do participante.
numeroDocumento Texto Número do documento.
dataEmissao Data Data de emissão do título.
dataVencimento Data Data de vencimento do título.
valorNominal Decimal Valor nominal do título.
valorAquisicao Decimal Valor de aquisição do título.
bancoCobranca Número Código do banco de cobrança.
agenciaCobranca Número Agência de cobrança.
especie Texto Descrição da espécie do título (ex.: Duplicata, UR, CCB Pré Digital).
jurosMoraDiaAtraso Decimal Juros aplicados por dia de atraso.
valorAbatimento Decimal Valor de abatimento do título.
valorDesconto Decimal Valor de desconto concedido no título.
tags Lista de texto Tags associadas ao título.
sacado Objeto Dados do pagador. Mesmos campos do Sacado da requisição; no retorno, uf é devolvido por extenso (ex.: Santa Catarina (SC)).
lastro Objeto Dados do lastro, quando houver. Mesmos campos do Lastro da requisição, mais chaveCte (chave do CT-e, quando o lastro é um CT-e); no retorno, tipoLastroPerformado é devolvido por extenso (ex.: Bens performado) e chaveAcessoNfe, inscricaoMunicipal e codigoMunicipioIBGE vêm vazios.

Título não incluído

Campo Tipo Descrição
numeroControleParticipante Texto Vem vazio: o número de controle não é devolvido nos títulos recusados. Identifique o título pelos demais campos.
numeroDocumento Texto Número do documento recusado.
dataEmissao Data Data de emissão informada.
dataVencimento Data Data de vencimento informada.
valorNominal Decimal Valor nominal informado.
especie Texto Descrição da espécie do título (ex.: Duplicata), e não a sigla enviada.
documentoSacado Texto Documento do sacado, quando disponível. Pode vir nulo.
motivo Texto Motivo da recusa.

Respostas de erro

Os erros retornam 400 Bad Request no mesmo formato do retorno, com status "erro" e titulosIncluidos vazia. Neles, nenhum título é gravado.

Situação mensagem titulosNaoIncluidos
Operação informada na rota não existe. Operação com ID {idOperacao} não encontrada. Vazia.
Cedente não cadastrado. Empresa com o CNPJ {cpfCnpj} não encontrada. Vazia.
Cedente inativo. Cedente {cpfCnpj} está inativo e não pode receber novos títulos. Vazia.
Cedente não vinculado à operação. Cedente com CNPJ '{documento}' não encontrado ou não vinculado a essa operação. Vazia.
Operação valida lastro e algum título veio sem lastro (exceto CCB Pré Digital e UR). Erro ao importar títulos avulsos. Títulos sem lastro, com motivo As informações de lastro são obrigatórias.
CPF ou CNPJ do sacado com dígito verificador inválido. Erro ao importar títulos avulsos. Títulos com o documento inválido, com motivo CPF/CNPJ do sacado inválido.

Observações

  • Sem lote: este endpoint não cria lote nem vincula os títulos a um lote existente. Para o fluxo tradicional de cessão em lote, utilize Criar Lote seguido de Adicionar Títulos.
  • Código do originador: o campo opcional codigoOriginador é aceito tanto nesta importação avulsa quanto na inclusão de títulos em lote.
  • Operação inexistente: se a operação informada na rota (idOperacao) não existir, a importação é rejeitada com 400 Bad Request e a mensagem Operação com ID {idOperacao} não encontrada., antes de qualquer gravação. Confirme que o idOperacao é o identificador fornecido pela Vertrau.
  • Cedente: o cedente informado precisa estar previamente vinculado à operação. Caso contrário, a importação é rejeitada.
  • Cedente inativo: se o cedente (resolvido pelo cpfCnpj) estiver inativo, a importação é rejeitada com 400 Bad Request e a mensagem Cedente {cpfCnpj} está inativo e não pode receber novos títulos., antes de qualquer gravação. Títulos e lotes já em andamento não são afetados; basta reativar o cedente para voltar a importar novos títulos.
  • Validações de título: as mesmas regras de validação aplicadas no fluxo de adição em lote (cedente, sacado, lastro, espécie, datas, valores) são executadas aqui. Erros específicos por título retornam na lista titulosNaoIncluidos do response.