Informar Pagamento da Duplicata

PUT

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

Nesta API, você registra um pagamento na duplicata escriturada, atualizando seu status e os saldos no sistema de escrituração. Para usá-la, informe seu tenantId (CPF ou CNPJ da empresa) e o IUD da duplicata a ser quitada. No corpo da requisição, descreva a forma de pagamento utilizada, identifique quem está declarando a quitação, indique se a quitação é parcial ou total, informe o valor pago e, se for o caso, o valor remanescente, o documento do beneficiário que recebe o pagamento e a data em que a operação foi efetivamente realizada. Com esses dados, o sistema valida e registra a quitação, ajusta o valor em aberto e muda o status do título, garantindo que a duplicata reflita fielmente a situação financeira e jurídica.

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

🟢204OK

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 PUT 'https://app.qescritural.com.br/api/bookkeeping/integration/v1/83696183000159/trade-receivable-certificates/J3569914425302000001/payment' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "bankSlip",
    "informantId": "directByDrawerHolder",
    "isPartial": false,
    "paymentValue": 5657645.43,
    "remainingValue": 23523.32,
    "beneficiaryDocument": "stringstrin",
    "paymentDate": "2025-11-15"
}'

Response Example

204 - Exemplo 1

{}

Informar Pagamento da Duplicata

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API