POST Boletos - Varejonline/api GitHub Wiki
URL
Parâmetros
Envie um JSON no corpo da requisição, contendo:
- idContaReceber: id da conta a receber para a qual deseja-se emitir um boleto. A conta a receber tem que estar aberta (não-baixada) e não possuir um boleto já emitido para ela. (long) (obrigatório)
- idCarteiraCobranca: id da carteira de cobrança a ser utilizada. A carteira de cobrança tem que estar habilitada no sistema se for para cobrança registrada. (long) (obrigatório)
Retorno
Retorna um Json com informações do resultado da operação realizada, contendo:
- idRecurso: id da categoria gerada.
- codigoMensagem: Código de identificação da operação realizada. [veja a lista de Códigos] (Retorno-API)
- mensagem: Mensagem da operação realizada
Exemplo
'Content-Type'='application/json'
{
"idContaReceber":4432432,
"idCarteiraCobranca":1
}
Exemplo de retorno:
Sucesso:
- HTTP STATUS 201 – CREATED
- Body:
{
"idRecurso": 1,
"codigoMensagem": 0,
"mensagem": "Operação realizada com sucesso."
}
Requisição inválida:
- HTTP STATUS 400 – BAD REQUEST
- Body:
{
"idRecurso": 0,
"codigoMensagem": 51,
"mensagem": "Carteira de cobrança não habilitada"
}