Listar as manifestações do sacado - V2

Lista as manifestações do sacado autenticado, com o status de cada uma. A consulta é feita apenas na base da Shipay, sem consulta à registradora.

O histórico é completo: a mesma duplicata pode aparecer mais de uma vez, por exemplo uma anotação comercial depois do aceite, ou um aceite depois de uma recusa.

Só aparecem manifestações de duplicatas do sacado autenticado. Um filtro que não encontra nada devolve 200 com data vazio.

Quando os filtros iud, registered_invoice_id ou process_id trazem identificadores sem manifestação no período consultado, eles voltam em errors[] com code NOT_FOUND:

SituaçãoStatus
Só identificadores encontrados, ou sem esses filtros200
Parte encontrada, parte não207
Nenhum identificador encontrado422
Query Params
iud
array of strings
length ≤ 100

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
length ≤ 100

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

registered_invoice_id
process_id
array of uuids
length ≤ 100

Lista de identificadores de processamento, devolvidos no envio, separados por vírgula. Traz todas as manifestações daqueles lotes.
Lista limitada a 100 identificadores por requisição.

process_id
string
enum

Filtra pela situação da manifestação.

Allowed:
string
enum

Filtra pelo tipo da manifestação.

Allowed:
date

Data inicial de envio da manifestação à Shipay. Sem nenhuma das duas datas, o padrão é dos últimos 30 dias até hoje. Enviando só created_at__gte, created_at__lte é calculada como created_at__gte + 30 dias. O intervalo entre as duas datas não pode passar de 180 dias.

date

Data final de envio da manifestação à Shipay. Sem nenhuma das duas datas, o padrão é dos últimos 30 dias até hoje. Enviando só created_at__lte, created_at__gte é calculada como created_at__lte − 30 dias. O intervalo entre as duas datas não pode passar de 180 dias.

string
enum
Defaults to created_at__desc

Ordenação pela data de envio da manifestação à Shipay.

Allowed:
integer
1 to 500
Defaults to 100

Quantidade máxima de registros por página.

integer
≥ 0
Defaults to 0

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

Headers
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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json