Skip to main content
GET
cURL

Quando usar

Para responder “quem está devendo documento?”: filtre por SENT e IN_PROGRESS e olhe o prazo. itemsAwaitingOperator diz quantos itens esperam uma decisão sua, que é a fila que trava a solicitação do lado de dentro.
Contexto e vocabulário em Solicitações de coleta. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Query Parameters

status
enum<string>[]

Um ou mais status. Repita o parametro para varios.

Available options:
DRAFT,
SENT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
CANCELED
registryId
string

Filtra por cadastro.

document
string

Filtra pelo CNPJ/CPF do cadastro.

Casa por nome ou documento.

Maximum string length: 120
templateId
string

Filtra por modelo.

from
string

Inicio do periodo de criacao, ISO 8601.

to
string

Fim do periodo de criacao, ISO 8601.

skip
number

Deslocamento da pagina.

take
number

Tamanho da pagina.

Required range: x <= 100

Response

Pagina de solicitacoes com status, cadastro, prazo e progresso.

items
object[]
total
integer