Atualizar Duplicata

PATCH

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

Nesta API, você pode corrigir ou ajustar os dados de uma duplicata escriturada que já está registrada em seu tenant. É utilizada quando é necessário alterar o valor do título, a data de vencimento ou o domicílio de pagamento, mantendo a conformidade com as regras do Banco Central e a trilha de auditoria. No corpo da requisição, inclua os campos que deseja atualizar. Ao receber os dados, o sistema registra a alteração com a justificativa, atualiza os campos modificados e gera um evento de atualização da duplicata, preservando o histórico original para controle e conformidade.

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' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 200523,
    "dueDate": "2025-11-15",
    "paymentDomicile": {
        "type": "pix",
        "transfer": {
            "ispb": "237",
            "branch": "23523",
            "branchDigit": "3",
            "account": "3287362",
            "accountDigit": "85",
            "accountType": "checkingAccount",
            "holderTaxId": "27740192732"
        },
        "pix": {
            "keyType": "cpf",
            "key": "string"
        }
    },
    "changeJustification": "Valor errado"
}'

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

Bloquear Duplicata

Próxima página

Registro na Duplicata Escritural

Atualizar Duplicata

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API