Bloquear Duplicata

PATCH

https://app.qescritural.com.br/api/bookkeeping/integration/v1/{tenantId}/trade-receivable-certificates/{uid}/block

Nesta API, você pode altera a situação da duplicata para Bloqueada no sistema de escrituração para impedir que ela seja negociada, cedida ou utilizada como garantia enquanto durar o bloqueio. No corpo da requisição, opcionalmente indique o novo valor de tradeReceivableStatus use locked para bloquear e unlocked para liberar. O sistema registra essa alteração e passa a considerar a duplicata como bloqueada ou desbloqueada, refletindo a decisão do sacador ou da registradora em razão de contestação, suspeita de fraude ou outro motivo operacional.

Checklist de uso da API

Realizei login

Estou com Bearer Token atualizado

Tenho tenantId da minha conta

Tenho o UID da minha duplicata

Envio a requisição com as informações abaixo

Requisição

Authorization

Bearer Token

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 Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Body

🟠400Erro de validação

🟠401Não autorizado

🟠403Acesso negado

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://app.qescritural.com.br/api/bookkeeping/integration/v1/83696183000159/trade-receivable-certificates/J3569914425302000001/block' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tradeReceivableStatus": "unlocked"
}'

Response Example

200 - Exemplo 1

{
    "tradeReceivableId": "20",
    "status": "unlocked",
    "changeProtocol": "ALT-DUP-20251120",
    "updatedAt": "2025-11-17T20:30:23.000Z",
    "changeHash": "315f5bdb76d078c43b8ac0064e4a016461238b88b264e1839a7647883350616e"
}

Página anterior

Informar Pagamento da Duplicata

Próxima página

Atualizar Duplicata

Bloquear Duplicata

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API