Ir al contenido
Claro
Español

API de Demander - Valores financieros

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar valores financieros.

Listar los valores financieros de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

Rota: {host}/public/v1/titulos-financeiros?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Retorno:

{
"titulosFinanceiros": [
{
"codigo": "5349",
"numParcela": "1",
"cpfCNPJCliente": "10.449.962/0001-86",
"dataEmissao": "2020-01-02 00:00:00",
"dataVencimento": "2020-02-01 00:00:00",
"tipoTitulo": "Duplicata",
"valor": 5792,
"quitado": 0,
"ativo": 1,
"valorMultaJuros": 0,
"codCliente": 4441,
"dataUltimaAtualizacao": "2020-02-28 14:30:00",
"numeroDocumento": "NF-e 1024 / Pedido 102345",
"dataPagamento": null,
"valorComissao": 0,
"codFilial": null,
"codVendedor": null,
"dataAlteracao": "2026-07-27 10:00:00"
}
]
}

POST inserción mediante la tecla compuesta codigo + numParcela.

Rota: {host}/public/v1/titulos-financeiros
Método: POST
Body: json
Propiedad Tipo Tamaño Obligatorio Descripción
código cadena 30 ✓ Código de título. Parte de la clave upsert.
numParcela cadena 20 Número de paquete. Parte de la clave upsert. Se puede omitir.
cpfCNPJCliente cadena 20 ✓ Cliente CPF/CNPJ. Acepta con o sin mascarilla; la API escribe formateada.
dataEmissao fecha ✓ Fecha de emisión. Formato Y-m-d.
dataVencimento fecha ✓ Fecha de expiración. Formato Y-m-d.
tipoTitulo cadena 50 ✓ Tipo de título. Ej.: Boleto, Cheque, Duplicado.
valor decimal ✓ Valor del título. Acepta 0.
dio sus frutos entero Valores: 0 (abierto) o 1 (pagado). Valor predeterminado de inclusión: 0.
activo entero Valores: 0 o 1. Valor predeterminado de inclusión: 1.
valorMultaJuros decimal Valor acumulado de multas e intereses. Valor predeterminado de inclusión: 0.
codCliente entero Código de cliente en Demander.
dataUltimaAtualizacao fechahora Utilizado por el módulo Registro de facturación.
numeroDocumento cadena 50 Número del documento que generó el título. Ej.: NF-e 1024.
dataPagamento fecha Fecha de pago. Llene sólo si el título está pagado.
valorComissao decimal Importe de la comisión del vendedor. Valor predeterminado de inclusión: 0.
codFilial cadena 15 Código de la sucursal vinculada al título.
codVendedor entero Si se le informa, restrinja la visualización al vendedor y a sus gerentes.

Cuerpo:

{
"codigo": "5349",
"numParcela": "1",
"cpfCNPJCliente": "10.449.962/0001-86",
"dataEmissao": "2020-01-02",
"dataVencimento": "2020-02-01",
"tipoTitulo": "Duplicata",
"valor": 5792.0,
"quitado": 0,
"ativo": 1,
"valorMultaJuros": 0,
"codCliente": 4441,
"dataUltimaAtualizacao": "2020-02-28 14:30:00",
"numeroDocumento": "NF-e 1024 / Pedido 102345"
}

Retorno:

{
"codigo": "5349",
"numParcela": "1",
"cpfCNPJCliente": "10.449.962/0001-86",
"dataEmissao": "2020-01-02 00:00:00",
"dataVencimento": "2020-02-01 00:00:00",
"tipoTitulo": "Duplicata",
"valor": 5792,
"quitado": 0,
"ativo": 1,
"valorMultaJuros": 0,
"codCliente": 4441,
"dataUltimaAtualizacao": "2020-02-28 14:30:00",
"numeroDocumento": "NF-e 1024 / Pedido 102345",
"dataPagamento": null,
"valorComissao": 0,
"codFilial": null,
"codVendedor": null,
"dataAlteracao": "2026-07-27 10:00:00"
}

Elimina el título financiero.

Rota: {host}/public/v1/titulos-financeiros?codigo={codigo}&numParcela={numParcela}
Método: DELETE

Retorno:

{
"mensagem": "Registro excluído com sucesso."
}