Buscar PDFs

Requisição

GET [Url Ambiente]/cobrancas/pdfs

Header

Identificador	Valor
Accept	application/json
X-Api-Key	Token de acesso à API
x-idtokenoper	Token do contrato

Query

Parâmetro	Descrição	Tipo	Exemplos
numero_documento	Número do documento do Cliente/Fornecedor (CPF/CNPJ)	String
data_inicio	Data início (aaaa-mm-dd)	String
data_fim	Data fim (aaaa-mm-dd)	String

Exemplo

curl -X GET --header 'Accept: application/json' --header 'X-Api-Key: e26f1ae9-d729-4fa9-bdd9-d2cbdcb5fa94' --header 'x-idtokenoper: 0c3a7999-06c9-4680-8a8a-aeb57965c468' 'https://sistemacontas.com.br/contas/api/v1/cobrancas/pdfs?numero_documento=01234567890&data_inicio=2026-01-01&data_fim=2026-01-31'

Resposta

Status Code 200

Retorno de sucesso.

Em caso de sucesso é retornada uma lista com os links dos arquivos PDF. Seguem campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
nosso_numero	Número bancário da cobrança	String	9999991
valor	Valor da cobrança	Numeric	"50.00"
data_vencimento	Data de vencimento (aaaa-mm-dd)	String	"2026-01-01"
url	URL do arquivo PDF	String

[
    {
        "nosso_numero": "9999991",
        "valor": "40.00",
        "data_vencimento": "2026-01-01",
        "url": "https://sistemacontas.com.br"
    },
    {
        "nosso_numero": "9999992",
        "valor": "50.00",
        "data_vencimento": "2026-01-02",
        "url": "https://sistemacontas.com.br"
    },
    ...
]

Status Code 422

Falha na validação.

É retornado um objeto com os erros de validação.

{
    "title": "Falha na validação",
    "errors": {
        "data_fim": [
            "Formato inválido"
        ]
    }
}