ContractPlus APIs | Lançar Retenção Técnica.
3 min
Criado por Eduardo Martins Dos Santos em 15/08/2025 09:00
Atualizado por Eduardo Martins Dos Santos em 18/08/2025 11:42

❓ Dúvida

Como lançar uma retenção técnica.


⚠️ Informação Importante

O processo de retenção técnica é específico para contratos de fornecedores.

A API responsável por realizar o lançamento da retenção técnica é:

/api/contractGuaranteePaymentDúvida

🛠️ Procedimento

O processo de retenção contratual pode ser utilizado em contratos de fornecedores.
O valor retido é denominado “caução” e é configurado como imposto retido.

👉 Para mais informações sobre essa configuração, clique aqui.

Durante a inserção do contrato, o imposto configurado como caução deve ser informado na aba “Desconto/Impostos”, na grid “Impostos”.

Quando houver o lançamento da provisão da medição, o percentual configurado será automaticamente retirado da parcela medida e servirá como caução contratual, a ser resgatado ao término do contrato.

Exemplo prático:

  • Valor da medição: R$ 1.000,00

  • Imposto configurado: R$ 50,00 (5% de 1.000,00)

Após a medição, é preciso aprová-la (para mais informações sobre o processo de aprovação, clique aqui) e, em seguida, provisioná-la. Com a medição provisionada, o processo de criação ténica pode ser inicializado.

📝 Exemplo de JSON utilizado pela API:

{
  "contractId": 4901,
  "comments": "Comentário Retenção Técnica",
  "groupCode": -1,
  "payMethCod": "Cartão",
  "seqCode": -2,
  "serial": 2,
  "seriesStr": "777",
  "model": "6",
  "instNum": 0,
  "lines": [
    {
      "measurementId": 6870,
      "absEntry": 3066,
      "wtCode": "E08",
      "wtName": "Caução",
      "wtAmnt": 50,
      "account": "1.01.03.06.14",
      "origin": 1,
      "originEnum": 1
    }
  ]
}

📌 Preencha o JSON no campo “Request Body” e execute a API.

Se a inserção da retenção for realizada com sucesso, o número da retenção técnica gerada será exibido no campo Response Body.