ContractPlus APIs | Lançar Distrato Parcial
10 min
Criado por Eduardo Martins Dos Santos em 17/02/2025 14:49
Atualizado por Eduardo Martins Dos Santos em 05/06/2025 07:19

Dúvida

Como incluir Distrato Parcial.

/api/disagreement/partial

Exemplo de JSON a ser preenchido:

{
    "contractId": 4285,
        "dateAdd": "2025-06-04T17:46:48.578Z",
            "comments": "Distrato Parcial via API",
                "defaultReasonToCreate": 0,
                    "lines": [
                        {
                            "contractLineId": 3256,
                            "quantity": 0,
                            "value": 120.45,
                            "installments": [
                                {
                                    "installmentId": 0
                                }
                            ]
                        },
                        {
                            "contractLineId": 7155,
                            "quantity": 1,
                            "value": 0,
                            "balanceDisCont": 0,
                            "balanceDisContQuantity": 0,
                            "installments": [
                                {
                                    "installmentId": 85653
                                }
                            ]
                        }
                    ],
                        "documents": [
                            {
                                "description": "Distrato Parcial",
                                "comments": "Distrato Parcial",
                                "attachments": [
                                    {
                                        "fullFileName": "testedistratoparcial.txt",
                                        "file": "YW5leG8gZG8gc2NyaXB0IGRlIGRpc3RyYXRvIHRvdGFsDQo="
                                    }
                                ]
                            }
                        ]
}

Campos preenchidos nesta api:

contractId: Id do Contrato
dateAdd: Data de lançamento
comments: Observações
deafultReasonToCreate: Motivo padrão
contractLineId: Linha do contrato
quantity: Quantidade
value: Valor
installmentId: Id da parcela
documents: Documentos
attachments: Anexos
fullFileName: Nome do arquivo
file: Anexo(Formato Base 64)

OBSERVAÇÃO: Para itens do tipo de medição, deve ser informado ou o valor ou a quantidade de distrato, nunca os dois. Para itens com parcela, deve ser informado o installmentId apenas, deixando de ser necessário preencher valor ou quantidade.


Este artigo foi útil para você?
Últimos artigos visitados