Pesquisar CPRs da empresa

Em teste

GET

/v2/cpr-ag/list

Lista as CPRs não removidas da empresa do usuário autenticado, com busca, ordenação e paginação por deslocamento. search procura o texto no CPF ou CNPJ do cliente e na razão social dele, sem diferenciar maiúsculas de minúsculas. offset (a partir de 0, padrão 0) e limit (de 1 a 100, padrão 20) definem a página; total traz quantas CPRs atendem ao filtro, para montar a paginação. sort aceita emissionDate (padrão), clientName, taxId, value, dueDate, status, cprType, culture, crop e branch; order aceita asc ou desc (padrão desc). A lista inclui as CPRs registradas por qualquer rota de CPR da plataforma. amountPartial é a soma dos pagamentos já registrados. Parâmetros fora desses limites devolvem 422. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

CPRs da empresa

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠422Parâmetros de busca inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/cpr-ag/list?search=&offset=&limit=&sort=&order=' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "3f2b8c1e-0000-4000-8000-00000000c001",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "clientName": "AGRO EXEMPLO S.A.",
            "userRegisterName": "Maria Exemplo",
            "taxId": "11222333000181",
            "value": 150000,
            "amountPartial": 0,
            "dueDate": "2027-06-30",
            "emissionDate": "2026-10-01",
            "status": "registrada",
            "cprType": "fisica",
            "culture": "Soja",
            "crop": "",
            "branch": "Grãos",
            "urlDocument": "https://files.example.com/cpr/cpr-0001.pdf"
        }
    ],
    "total": 1
}

Modificado em 2026-10-13 09:47:06

Página anterior

Listar operações de uma cessão

Próxima página

Registrar CPR de um cliente