Skip to main content
GET
Consultar histórico de pagamentos da entidade

Autorizações

Authorization
string
header
obrigatório

OAuth2 Authorization Code flow

Parâmetros de caminho

id
string
obrigatório

CPF, CNPJ ou identificador da empresa (cmp_*).

Parâmetros de consulta

page_size
number

Quantidade máxima de consultas retornadas por fonte (padrão: 1; máximo: 100).

asOf
string

Data de referência (YYYY-MM-DD)

fields
string

Campos opcionais separados por vírgula: "summary.short", "summary.long" e "summary.mdx". Sem summary.*, o campo metadata.summary é omitido.

Resposta

200 - application/json

Consulta concluída. Verifique o status e a proveniência dos dados quando presentes.

object
string
padrão:list
obrigatório

Identificador do tipo do objeto

results
object[]
obrigatório

Lista de resultados da página atual

has_more
boolean
obrigatório

Indica se há mais resultados após esta página

metadata
object
obrigatório

Status e proveniência do domínio. Uma lista vazia deve ser interpretada junto com esses metadados.

next_cursor
string | null

Cursor da próxima página; nulo quando não há mais resultados.

type
string

Tipo dos resultados