Informações da Duplicata

GET

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

Nesta API, você consulta uma duplicata escritural já existente. Basta informar o tenantId e oUID do título e o sistema retorna todos os dados da duplicata, como valor original, vencimento, status, dados do sacador e sacado, documentos fiscais associados e histórico de eventos (protestos, pagamentos, alterações). Assim, você tem uma visão completa e atualizada da duplicata para validações e decisões de negócio.

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

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 GET 'https://app.qescritural.com.br/api/bookkeeping/integration/v1/83696183000159/trade-receivable-certificates/J3569914425302000001' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Exemplo 1

{
    "tradeReceivableCertificateId": 1,
    "certificateType": "merchandise",
    "drawerCertificateId": "1",
    "invoiceNumber": "98765",
    "totalInvoiceAmount": 1234567890123.99,
    "installment": "10",
    "writtenAt": "2025-11-17T12:20:30",
    "originalDueDate": "2025-11-17",
    "maturityUpdate": {
        "modifiedDueDate": "2025-11-17",
        "dueDateChangeAt": "2025-11-17"
    },
    "originalValue": 9236859.5,
    "faceAmountUpdate": {
        "modifiedValue": 2423523.5,
        "valueChangeAt": "2025-11-17"
    },
    "ibgePaymentPlaceDraweeId": 3550308,
    "status": "active",
    "drawerSituation": "unlocked",
    "originType": "brda",
    "drawer": {
        "document": "55943193952",
        "personName": "José Moreira",
        "signatureDescription": "Assinatura eletrônica",
        "signature": "ASSINATURA-HASH-789"
    },
    "drawee": {
        "document": "91935872958",
        "personName": "Maria Silvia",
        "postalAddress": {
            "streetDescription": "Rua Alcemir de Souza Mota",
            "streetNumber": "478",
            "complement": "Apto. 203",
            "postalCode": "69305295",
            "municipalityDescription": "Boa Vista",
            "stateDescription": "Roraima"
        }
    },
    "protestInformation": [
        {
            "protest": {
                "protestDate": "2025-11-12"
            },
            "protestCancellation": {
                "cancellationDate": "2025-11-13"
            }
        }
    ],
    "associatedTaxDocument": [
        {
            "documentType": "cfel",
            "accessKey": "2",
            "documentCode": "98765",
            "registrationDateTime": "2025-11-15"
        }
    ],
    "holder": {
        "document": "17682734213",
        "personName": "Antônia Evelyn Lorena Lima"
    },
    "beneficiary": {
        "document": "93919420080",
        "holderName": "Andreia Fátima Patrícia da Cruz"
    },
    "billingInformation": {
        "dueDate": "2025-11-15",
        "payableAmount": 235235.17,
        "discountAmount": 500,
        "penaltyAmount": 300.22,
        "interestAmount": 2353.69,
        "feesAmount": 3253.13,
        "protestIndicator": false,
        "paymentInstrument": {
            "cashAccount": {
                "accountServicer": {
                    "clearingSystemCode": "237",
                    "brazilianPaymentSystemIdentifier": "60746948"
                },
                "accountType": "checkingAccount",
                "accountServicerBranch": "0001",
                "accountIdentification": "973265",
                "accountDigit": "77"
            },
            "instantPaymentAccountKey": {
                "instantPaymentKeyType": "cpf",
                "instantPaymentKey": "93919420080"
            },
            "bankPaymentSlip": {
                "paymentSlipIdentification": "00190.00009 00000.000000 00000.000000 1 91230000012345"
            }
        }
    },
    "settledPayment": [
        {
            "registrationDateTime": "2025-11-15",
            "instrumentType": "bankSlip",
            "informantType": "directByDrawerHolder",
            "isPartial": false,
            "paymentValue": 500,
            "remainingValue": 1000,
            "beneficiaryDocument": "93919420080"
        }
    ],
    "draweeResponse": [
        {
            "registrationDateTime": "2025-11-15",
            "manifestationType": "accept",
            "indicatedMaturityDate": "2025-11-15",
            "indicatedDuplicateValue": 20545.34,
            "commercialNotes": "Motivo: deadlines | Prazos informados para duplicatas selecionadas | Recebido: Não",
            "negotiationKnowledgeIndicator": false,
            "merchandiseReceiptIndicator": false
        }
    ]
}

Página anterior

Associar documento fiscal à duplicata

Próxima página

Listar Duplicatas

Informações da Duplicata

Checklist de uso da API#

Requisição

Respostas

Checklist de uso da API