Registrar Aval

POST

https://app.qescritural.com.br/api/bookkeeping/integration/v1/{tenantId}/act/guarantee

Nesta API, você registra um aval de duplicatas, garantindo o pagamento ao credor pelo avalista.Você precisa informar o tenantId, o tipo de titularidade (drawer ou holder), o CPF/CNPJ e o nome legal do titular, e um identificador único da operação (e, se aplicável, o código IPOC). Você precisa fornecer as datas de vigência, o valor total e o valor de garantia, definindo também o tipo de garantia (AVAL ou AVAC) e a parte garantida (sacador ou sacado). Inclua as informações do avalista e, se for o caso, do cônjuge. Liste os UIDs das duplicatas e o CPF/CNPJ do sacado. O sistema validará e registrará o aval, atualizando as duplicatas no sistema.

Checklist de uso da API

Realizei login

Estou com Bearer Token atualizado

Tenho tenantId da minha conta

Tenho as informações da duplicata

Tenho as informações do avalista

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 POST 'https://app.qescritural.com.br/api/bookkeeping/integration/v1/83696183000159/act/guarantee' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ownershipType": "drawer",
    "ownershipIdentification": "86649606154",
    "ownershipLegalName": "Luciana Joana Liz Oliveira",
    "certificateNegotiationReference": "FB8D6B18-F18F-471A-8A57-02DF71284489",
    "creditOperationIdentifier": "IPOC000001234567890ABCDEFGHIJKLMNPQRSTVWXYZ1234567890ABCDEFGHIJKLMNPQRSTV",
    "startDate": "2025-11-15",
    "endDate": "2025-11-15",
    "totalAmount": 235235.35,
    "guaranteedAmount": 12412421.32,
    "guarantee": [
        {
            "guaranteeType": "AVAL",
            "guaranteeAmount": 1,
            "avalBackedParty": "SACD",
            "guarantor": {
                "identification": "34098777975",
                "legalName": "Julio Sérgio Castro",
                "email": "julio_castro@gmail.com",
                "signature": "f5a18f9952e6953141539b6e69b4d79958cf0e75566f3489281496b27393686c",
                "signatureType": "ASDG",
                "signatureDate": "2025-11-12T12:30:12.000Z"
            },
            "guarantorSpouse": {
                "identification": "30616403550",
                "name": "Cauã Gustavo Cardoso"
            }
        }
    ],
    "actReceivables": [
        {
            "drawerIdentification": "00941170047",
            "tradeReceivableCertificateUniqueIdentifications": [
                "J7284200025185A4EJZZ"
            ]
        }
    ]
}'

Response Example

200 - Success

{
    "title": "One or more validation errors occurred.",
    "status": 400,
    "errors": {
        "Email": [
            "The Email field is required."
        ]
    }
}

Página anterior

Registrar Endosso-Penhor

Próxima página

Registrar Endosso-Mandato

Registrar Aval

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API