Skip to main content
GET
Retorna duplicatas

Authorizations

x-api-key
string
header
required

Chave da API gerada no Agulhão

Query Parameters

dataInicial
string<date>
required

Data inicial para filtro (yyyy-MM-dd)

dataFinal
string<date>
required

Data final para filtro (yyyy-MM-dd)

agrupadoPorCliente
boolean

Indica se as duplicatas devem ser agrupadas por cliente

duplicatas
string

Lista de IDs de duplicatas separados por vírgula

Example:

"1,2,3"

tipo
enum<string>
required

Tipo do retorno das duplicatas

Available options:
aberto,
vencido,
comPagamento,
liquidado

Response

Retorno das duplicatas conforme tipo solicitado

id
integer<int64>
clienteId
integer<int64>
clienteCpfCnpj
string
filialId
integer<int64>
filialNome
string
pedidoId
integer<int64>
parcelas
string
dataEmissao
string<date-time>
vencimento
string<date-time>
status
enum<string>
Available options:
A,
I
tipo
string
tipoDescricao
string
valor
number<float>
saldo
number<float>
numero
string