As despesas permitem aplicar custos e ajustes financeiros sobre um lote de cessão. Cada despesa pode ser informada como valor absoluto ou percentual e pode ser abatida no lote como um todo ou rateada por título.

Adicionar Despesas¶

Método	URL
	`https://BASE_URL/recebiveis/lotes/{idLote}/despesas`

Request Body

{
  "despesas": [
    {
      "valor": 5.0,
      "tipoDespesa": 1,
      "percentual": false,
      "porTitulo": true
    },
    {
      "valor": 2.5,
      "tipoDespesa": 2,
      "percentual": true,
      "porTitulo": false
    }
  ]
}

Response Body

{
  "status": "sucesso",
  "mensagem": "2 despesa(s) adicionada(s) com sucesso."
}

Modelo de dados¶

Requisição¶

Campo	Tipo	Descrição
`despesas`	Lista de Despesas	Lista das despesas a serem adicionadas ao lote. Informe ao menos uma despesa.

Despesa¶

Campo	Tipo	Descrição
`valor`	Decimal	Valor da despesa. Quando `percentual` for `true`, representa um percentual; caso contrário, um valor absoluto.
`tipoDespesa`	Número	Tipo da despesa. Ver Tipos de Despesa
`percentual`	Booleano	Indica se `valor` é um percentual (`true`) ou um valor absoluto (`false`).
`porTitulo`	Booleano	Indica se a despesa é rateada por título (`true`) ou abatida no lote como um todo (`false`).

Tipos de Despesa¶

Id	Tipo	Descrição
1	Custo por Boleto	Custo cobrado por boleto.
2	Taxa Diferença Deságio	Taxa referente à diferença do deságio.
3	Manual	Valor informado manualmente.
4	Taxa	Taxa fixa aplicada ao lote.

Retorno¶

Campo	Tipo	Descrição
`status`	Texto	Status de sucesso
`mensagem`	Texto	Mensagem de sucesso

Remover Despesa¶

Remove uma despesa específica de um lote.

Método	URL
	`https://BASE_URL/recebiveis/lotes/{idLote}/despesas/{idDespesa}`

Parâmetro	Tipo	Descrição
`idLote`	Número	Identificador do lote.
`idDespesa`	Número	Identificador da despesa a ser removida.

Response Body

{
  "status": "sucesso",
  "mensagem": "Despesa removida com sucesso."
}

Consultar Despesas¶

Lista todas as despesas de um lote.

Método	URL
	`https://BASE_URL/recebiveis/lotes/{idLote}/despesas`

Response Body

[
  {
    "id": 101,
    "idLote": 987,
    "valor": 5.0,
    "percentual": false,
    "porTitulo": true,
    "tipo": 1
  }
]

Campo	Tipo	Descrição
`id`	Número	Identificador da despesa.
`idLote`	Número	Identificador do lote.
`valor`	Decimal	Valor da despesa (absoluto ou percentual, conforme `percentual`).
`percentual`	Booleano	Indica se `valor` é um percentual (`true`) ou um valor absoluto (`false`).
`porTitulo`	Booleano	Indica se a despesa é rateada por título (`true`) ou abatida no lote como um todo (`false`).
`tipo`	Número	Tipo da despesa. Ver Tipos de Despesa