Busca detalhes de um relatório de duplicatas - V2

get

https://dup-api-stg.shipay.com.br/v2/buyers/reports

Esta rota síncrona entrega o relatório atualizado de duplicatas vinculadas ao sacado, consolidado no Hub Shipay a partir das notificações e consultas integradas às registradoras e escrituradoras.

A nova versão visa otimizar a navegação, o processamento e a performance do lado do cliente, trazendo suporte a múltiplos filtros de pesquisa, ordenação personalizada dos resultados e um sumário de dados totalizados na resposta, além do detalhamento individual das duplicatas encontradas.

Query Params

status

string

enum

Status da duplicata.

Valor	Descrição
`finished`	Liquidada totalmente.
`created`	Aberta (sem pagamento ou liquidada parcialmente).
`cancelled`	Cancelada.

Allowed:

expiration_date__gte

date

Data inicial do intervalo de vencimento. A busca inclui a data informada.

expiration_date__lte

date

Data final do intervalo de vencimento. A busca inclui a data informada.
Caso não seja informada, o valor padrão é de 30 dias a partir da data inicial.
O intervalo entre as datas é limitado a 6 (seis) meses.

issue_date__gte

date

Data inicial do intervalo de emissão. A busca inclui a data informada.

issue_date__lte

date

Data final do intervalo de emissão. A busca inclui a data informada.
Caso não seja informada, o valor padrão é de 30 dias a partir da data inicial.
O intervalo entre as datas é limitado a 6 (seis) meses.

updated_at__gte

date

Data inicial do intervalo de atualização. A busca inclui a data informada.

updated_at__lte

date

Data final do intervalo de atualização. A busca inclui a data informada.
Caso não seja informada, o valor padrão é de 30 dias a partir da data inicial.
O intervalo entre as datas é limitado a 6 (seis) meses.

amount

float

Valor exato da duplicata.

amount__gte

float

Valor inicial do intervalo de valor da duplicata.

amount__lte

float

Valor final do intervalo de valor da duplicata.

drawer_name

string

Nome do sacador. Aceita busca parcial com um mínimo de 3 (três) caracteres.

drawer_document_number

string

Documento do sacador (CPF/CNPJ). Aceita com ou sem máscara: ponto, traço e barra são removidos antes da consulta.
CPF: 11 dígitos, somente números, com dígitos verificadores válidos.
CNPJ: 14 caracteres, aceitando tanto o formato numérico quanto o alfanumérico (letras de A a Z nas 12 primeiras posições), com dígitos verificadores válidos.
Qualquer outro tamanho, ou dígito verificador inválido, devolve 422 com o envelope de erro padrão, sem consultar a base.

iud

array of strings

Lista de IUDs (Identificadores Únicos da Duplicata) separados por vírgula.
Lista limitada a 100 identificadores por requisição.

iud

registered_invoice_id

array of uuids

Lista de UUIDs das duplicatas separados por vírgula.
Lista limitada a 100 identificadores por requisição.

registered_invoice_id

order_by

string

enum

Defaults to issue_date__desc

Campo e direção para ordenação dos resultados.

Valor	Descrição
`expiration_date__asc`	Data de vencimento (crescente).
`expiration_date__desc`	Data de vencimento (decrescente).
`issue_date__asc`	Data de emissão (crescente).
`issue_date__desc`	Data de emissão (decrescente).
`amount__asc`	Valor (crescente).
`amount__desc`	Valor (decrescente).
`updated_at__asc`	Data de atualização (crescente).
`updated_at__desc`	Data de atualização (decrescente).

offset

integer

Defaults to 0

Quantidade de registros a serem ignorados para paginação.

limit

integer

Defaults to 100

Quantidade máxima de registros por página.
Máximo limitado a 500 (quinhentos) registros por página.

Headers

X-Request-Id

string

Identificador de rastreio da requisição, ecoado nos logs da Shipay. Quando não enviado, a Shipay gera um.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Detalhes das duplicatas retornadas com sucesso.

207Detalhes das duplicatas retornadas com sucesso e com erro.

401Token de acesso ausente, inválido ou expirado.

403Requisição sem credenciais de autenticação.

422Nenhuma das duplicatas informadas em registered_invoice_id ou iud foi encontrada.