Duplicatas Escriturais | Quick Soft
Documentação
Documentação
  1. Duplicata
  • Instruções Gerais
    • Como começar
  • Qautenticação
    • Guias
    • Referencias
      • Login
  • Qescritural
    • Guias
      • Duplicata Escritural
      • Emissão de duplicata por digitação manual
      • Associação de documento fiscal
      • Consulta de Protocolo - duplicata sem documento fiscal
    • Referencias
      • Gestão de Usuários
        • Cadastro de Usuário Master
      • Escrituração de Duplicatas
        • Importar XML da NFe
        • Listar NFe importadas - XML
        • Emitir duplicatas sem documento fiscal associado
        • Consulta de Protocolo de duplicatas emitidas
        • Associar documento fiscal à duplicata
      • Duplicata
        • Informações da Duplicata
          GET
        • Listar Duplicatas
          GET
        • Listar Solicitações de Extrato
          GET
        • Download Extrato
          GET
        • Solicitar Extrato
          POST
        • Cancelar Duplicata
          PUT
        • Informar Pagamento da Duplicata
          PUT
        • Bloquear Duplicata
          PATCH
        • Atualizar Duplicata
          PATCH
  • Qregistro
    • Guias
      • Registro na Duplicata Escritural
    • Referencias
      • Efeito de Negociação
        • Cancelamento
          • Cancelar Ato
          • Cancelar Duplicata em uma operação
        • Registrar Endosso
        • Registrar Endosso-Penhor
        • Registrar Aval
        • Registrar Endosso-Mandato
        • Registrar Endosso-Substabelecimento
Documentação
Documentação
  1. Duplicata

Cancelar Duplicata

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

Nesta API, você cancela uma duplicata escriturada. Para isso, envie uma requisição autenticada com seu tenantId (CNPJ/CPF), o UID da duplicata e um corpo JSON contendo a justificativa do cancelamento. O sistema valida os dados e registra o cancelamento do título, tornando-o inativo e indisponível para novas operações.

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 ********************
or
Parâmetros de Caminho

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
OK
Body

🟠400Erro de validação
🟠401Não autorizado
🟠403Acesso negado
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://app.qescritural.com.br/api/bookkeeping/integration/v1/83696183000159/trade-receivable-certificates/J3569914425302000001/cancel' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cancellationJustification": "Escrituração errônea"
}'
Response Response Example
200 - Exemplo 1
{
    "cancellationJustification": "Escrituração errônea",
    "tradeReceivableCertificateId": 20
}
Página anterior
Solicitar Extrato
Próxima página
Informar Pagamento da Duplicata
Built with