Registrar CPR de um cliente

POST

/cpr/register/{clientId}

Solicita o registro de uma CPR (Cédula de Produto Rural) emitida pelo cliente. Informe o tipo em cprType (fisica, financeira ou CPR-G), os dados da cédula e em urlDocument o endereço do documento da CPR já enviado.

O custo do registro, em créditos, é calculado como em Calcular custo de registro de CPR e debitado do saldo da empresa no momento da solicitação; empresa sem créditos cadastrados, bloqueada ou sem saldo suficiente recebe 400.

A CPR é gravada e o registro segue para processamento; a resposta 201 traz a CPR gravada, sem status de registro ainda.

taxId é o CPF ou CNPJ do cliente emitente, só dígitos, e precisa ser o de um cliente cadastrado na empresa.

cprType ou emissionDate ausentes, e data de vencimento inválida, devolvem 400; falhas ao gravar a CPR, como tipo fora da lista ou campo obrigatório ausente, também devolvem 400, com uma mensagem curta e pouco descritiva.

Cliente sem cadastro na empresa, valor menor ou igual a zero e produto de registro indisponível devolvem 404.

Só aceita clientes vinculados à empresa do usuário autenticado: cliente inexistente devolve 404, e cliente de outra empresa devolve 401.

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 Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

CPR registrada

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Dados da CPR inválidos ou sem créditos

🟠404Cliente, usuário ou produto não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cpr/register/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "taxId": "11222333000181",
    "cprType": "fisica",
    "emissionDate": "2026-09-01T03:00:00.000Z",
    "dueDate": "2027-03-31T03:00:00.000Z",
    "requestDate": "2026-09-28T12:00:00.000Z",
    "value": 250000.5,
    "urlDocument": "https://files.example.com/cpr/cpr-fazenda-exemplo.pdf",
    "isAutoCleared": false
}'

Response Example

201 - Sucesso

{
    "item": {
        "_id": "3f2b8c1e-0000-4000-8000-00000000c001",
        "companyId": "a1b2c3d4-0000-4000-8000-0000000000e1",
        "userId": "b2c3d4e5-0000-4000-8000-0000000000b1",
        "taxId": "11222333000181",
        "dueDate": "2027-03-31T03:00:00.000Z",
        "emissionDate": "2026-09-01T03:00:00.000Z",
        "requestDate": "2026-09-28T12:00:00.000Z",
        "value": 250000.5,
        "urlDocument": "https://files.example.com/cpr/cpr-fazenda-exemplo.pdf",
        "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "queryId": "c3d4e5f6-0000-4000-8000-0000000000d1",
        "cost": 105,
        "isAutoCleared": false,
        "type": "fisica",
        "trashed": false,
        "payments": [],
        "createdAt": "2026-09-28T12:00:01.544Z",
        "updatedAt": "2026-09-28T12:00:01.544Z"
    }
}

Modificado em 2026-10-22 17:20:53

Página anterior

Pesquisar CPRs da empresa

Próxima página

Registrar CPR Ag