Consultar lista de cobranças com vencimento.

GET

/cobv

CobV

Endpoint para consultar cobranças com vencimento através de parâmetros como início, fim, cpf, cnpj e status.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

cobv.read-Permissão para consulta de cobranças com vencimento

Parâmetros de Consulta

Respostas

🟢200

application/json

Lista de cobranças com vencimento.

Bodyapplication/json

🟠403AcessoNegado

🔴503ServicoIndisponivel

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cobv?inicio=undefined&fim=undefined&cpf=undefined&cnpj=undefined&locationPresente=undefined&status=undefined&paginacao.paginaAtual=undefined&paginacao.itensPorPagina=undefined'

Response Example

200 - Exemplo de retorno da consulta de cobranças com vencimento 1

{
    "parametros": {
        "inicio": "2020-04-01T00:00:00Z",
        "fim": "2020-04-01T23:59:59Z",
        "paginacao": {
            "paginaAtual": 0,
            "itensPorPagina": 100,
            "quantidadeDePaginas": 1,
            "quantidadeTotalDeItens": 1
        }
    },
    "cobs": [
        {
            "allOf": [
                {
                    "$ref": "#/components/examples/cobResponse4/value"
                }
            ]
        }
    ]
}

Página anterior

Gerenciamento de cobranças com vencimento

Próxima página

Criar cobrança com vencimento.