Retorna duplicatas

Retorna duplicatas em um intervalo de datas, por identificador ou agrupadas por cliente

GET /duplicatas

Retorna duplicatas

cURL

curl --request GET \
  --url https://api-integracoes.agulhao.com.br/duplicatas \
  --header 'x-api-key: <api-key>'

200

[
  {
    "id": 123,
    "clienteId": 123,
    "clienteCpfCnpj": "<string>",
    "filialId": 123,
    "filialNome": "<string>",
    "pedidoId": 123,
    "parcelas": "<string>",
    "dataEmissao": "2023-11-07T05:31:56Z",
    "vencimento": "2023-11-07T05:31:56Z",
    "tipo": "<string>",
    "tipoDescricao": "<string>",
    "valor": 123,
    "saldo": 123,
    "numero": "<string>"
  }
]

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

200

application/json

Retorno das duplicatas conforme tipo solicitado

Option 1 · object[]

Option 2 · object[]

Option 3 · object[]

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