O que você precisa resolver hoje?

  1. Página inicial
  2. Voltar para a pesquisa
  3. ContractPlus Web
ContractPlus | APIs
10 min
Criado por Lucas Daniel Natal do Couto em 29/01/2025 14:44
Atualizado por Eduardo Martins Dos Santos em 09/10/2026 13:54
Informação Importante:
Nem todos os processos do ContractPlus possuem APIs disponíveis no momento. À medida que novas APIs forem desenvolvidas, este artigo será atualizado com os respectivos processos.


COMECE POR AQUI

/api/security/token (POST)Obter autenticação.


ADIANTAMENTO

/api/ContractDownPayment/Add (POST)

Lançar adiantamento.

/api/ContractDownPayment/GetApprovedDownPaysByContract/{contractId} (GET)

Consultar adiantamentos que tiveram baixa financeira.

/api/ContractDownPayment/AddProvision/{DownPaymentId} (POST)

Provisionar adiantamento.

/api/ContractDownPayment/Cancel/{id} (POST)

Cancelar Adiantamento.

/api/ContractDownPayment/GetShowDownPaysByContract/{contract} (GET)

Consultar adiantamentos provisionados de um contrato


ADITIVOS

/api/contractAdditives/additivesDatesConclusion (POST)Lança um Aditivo de Nova Data.
/api/contractAdditives/readjust (POST)Lança um Aditivo de Reajuste.
/api/contractAdditives/additivesService (POST)
Lança um Aditivo de Serviço.
/api/contractAdditives/additiveBusinessPartners (POST)
Lança um Aditivo de Parceiro de Negócios.
/api/contractAdditives/multipleAdjustments (POST)
Lança um Aditivo de Multiplos Ajustes.


APROVAÇÃO:

/api/approvalFlow/getAllPlaceId/{placeId}/{statusId} (GET)
Esta API retorna todo o fluxo de aprovação.
/api/approvalFlow/approvalFlow (POST)Esta API é responsável por executar o processo de aprovar um documento.
/api/approvalFlow/disaproveFlow (POST)
Esta API é responsável por executar o processo de reprovar um documento.
/api/approvalFlow/correctionFlow (POST)
Esta API é responsável por executar o processo de enviar um documento para correção.
/api/approvalPattern (POST)
Esta API é responsavel por criar um modelo de aprovação.
/api/ApprovalSequence (POST)
Esta API é responsavel por criar uma sequencia de aprovação.
/api/ApprovalSubstitute (POST)
Esta API é responsavel por criar um aprovador substituto.
/api/approvalPattern/{id} (PUT)
Esta API é responsavel por editar um modelo de aprovação.
/api/ApprovalSequence (PUT)
Esta API é responsavel por editar uma sequencia de aprovação.
/api/ApprovalSubstitute/{approvalSubstituteId}/active (PATCH)
Esta API é responsavel por ativar e desativar um aprovador substituto.
/api/approvalPattern/{id} (DELETE)
Esta API é responsavel por excluir um modelo de aprovação.
/api/ApprovalSequence/{id} (DELETE)
Esta API é responsavel por excluir uma sequencia de aprovação.
/api/approvalPattern/duplicate (POST)
Esta API é responsavel por duplicar um modelo de aprovação.
/api/approvalPattern (GET)
Esta API é responsavel por consultar os modelos de aprovação cadastrados.
/api/ApprovalSequence (GET)
Esta API é responsavel por consultar as sequencias de aprovação cadastrados.
/api/ApprovalSequence/{id} (GET)
Esta API é responsavel por consultar as sequencias de aprovação cadastrados filtrando por Id.
/api/approvalSubstitute (GET)
Esta API é responsavel por consultar os aprovadores substitutos cadastrados.
/api/approvalSubstitute/{id} (GET)
Esta API é responsavel por consultar os aprovadores substitutos cadastrados filtrando por Id.


CENTROS DE CUSTO

/api/centercostscode (GET)
Retorna os centros de custo cadastrados.
/api/centercostscode/{dimcode} (GET)
Retorna os centros de custo cadastrados por dimensão.


CLASSIFICAÇÕES CONTRATUAIS

/api/classifications (POST)
Cria uma classificação contratual.
/api/classifications (PUT)
Edita uma classificação contratual.
/api/classifications/{id} (DELETE)
Exclui uma classificação contratual.
/api/classifications (GET)
Retorna todas as classificações contratuais cadastradas.
/api/classifications/{id} (GET)
Retorna as informações da classificação contratual de acordo com o id.
/api/classifications/byName (GET)
Retorna as informações da classificação contratual de acordo com o nome.
/api/classifications/contractLinked/{classificationId} (GET)Retorna se a classificação contratual já possui vinculo com algum contrato.
/api/classificationType (GET)
Retorna os tipos de classificação contratual.


CLASSIFICAÇÕES POR USUÁRIO

/api/classificationUsers/add (POST)Adiciona um usuário a classificação por usuário.
/api/classificationUsers/remove (POST)

Remove um usuário da classificação por usuário.

/api/classificationUsers/{classification} (GET)

Retorna os usuários da classificação por usuário pelo id.

/api/classificationUsers/getAll (GET)

Retorna todos os usuários das classificações por usuário.


CONDIÇÕES DE PAGAMENTO

/api/conditionPayment (GET)
Retorna todas as condições de pagamento cadastradas.
/api/conditionPayment/getByGroupNum/{groupNum} (GET)

Retorna as informações da condição da pagamento pelo filtro groupNum.


CONTRATO

/api/contract (POST)Lança contrato de Fornecedor.
/api/contract (POST)
Lança contrato de Cliente.
/api/contract/{id}/blockOrUnblock (PATCH)
Bloqueia / Desbloqueia um contrato.
/api/contract/{id}/activate (PATCH)
Ativa um contrato.
/api/contract/{id}/close (PATCH)
Encerra um contrato.
api/documentImports/alternative-number/{alternativeNumber} (GET)
Utilizada para verificar se a inclusão do contrato foi bem-sucedida ou se houve falha. 
api/documentImports/hists/{alternativeNumber} (GET)
Registra erros que impediram a importação do contrato. O log de importação valida as informações antes do gerente de importação. Requer o número alternativo do contrato.
api/contract/getByAlternativeNumber/{AlternativeNumber} (GET)
Retorna todos os dados de um contrato.
/api/contract/{id} (GET)
Retorna as informações do contrato a partir do id.
/api/contract/Lines/{id} (GET)
Retorna as informações das linhas do contrato a partir do id.
/api/contract/GetByTypeId (GET)Retorna as informações do cabeçalho do contrato a partir do tipo.
/api/contract/GetByStatusId (GET)
Retorna as informações do cabeçalho do contrato a partir do status.


DISTRATO

/api/disagreement/total (POST)

Lançar distrato Total.
/api/disagreement/partial (POST)Lançar distrato Parcial.
/api/disagreement/conclusion (POST)
Lançar distrato Conclusão.
/api/disagreement/{disagreementId} (GET)
Consulta um distrato pelo ID.


DOCUMENTO

api/DocumentAttachments/setContractDocAttachAsSent (POST)Altera o status dos anexos do contrato para "Enviado"
api/DocumentAttachments/setContractDocAttachAsSigned (POST)Altera o status dos anexos do contrato para "Assinado"
api/DocumentAttachments/{contractType}/{attachmentStatus}/{contractStatus} (GET)
Retorna os anexos contratuais existentes na base de acordo com os parâmetros inseridos.


FATURAMENTO

api/Installment/openInstallmentsByContractId/{contractId} (GET)Retorna os IDs das parcelas disponíveis para serem liberadas para o faturamento.
api/Installment/release (POST)
Efetua a liberação das parcelas.
api/measurementApportionment/BillingAllowedByContractI/{contractId} (GET)
Retorna os IDs dos documentos disponíveis para faturar.
api/installment/bill (POST)
Efetua o faturamento das parcelas.
/api/installment/bill/custom (POST)
Efetua o faturamento das parcelas com datas personalizadas.
api/billing/documentSboDetails (GET)
Retornar os faturamentos feitos.
api/billing/documentSboDetails/{billingId}/lines (GET)
Retorna detalhes do faturamento.
/api/billingtype (GET)
Retorna os tipos de faturamento.
/api/billing/status (GET)
Retorna os status de faturamento.


FILIAIS

/api/businessPlace (GET)
Retorna as filiais cadastradas.


FINANCEIRO

/api/contract/downloadedFinancialBalanceOfContract/{contractId} (GET)
Retorna os valores já baixados no contas a receber do SAP de um contrato, incluindo adiantamentos e faturamentos.

/api/billingBankPlusAutomation/{docEntry}/{idClassification} (PATCH)

Atualizar campos "Gerar Boleto".


LOG DE MODIFICAÇÕES

/api/baseLogEntity/types (GET)

Retorna os tipos de log.

/api/baseLogEntity/logs (GET)

Retorna lista de log a partir do id base e tipo de log.

/api/baseLogEntity/diffs (GET)

Obtém as diferenças acumuladas desde o log informado até o mais recente.

/api/baseLogEntity/diffsByLog (GET)

Obtém diferenças entre dois logs.


MEDIÇÃO

/api/measurement/Add (POST)
Realiza a inclusão de uma medição contratual.
/api/measurement/PaymentProvisioning (POST)
Realiza o provisionamento de uma medição.
/api/measurement/Update (PUT)
Realiza a edição de uma medição contratual.
/api/measurement/cancel/{measurementId} (PATCH)
Cancela a medição contratual.
/api/measurement/cancelProvision/{measurementId} (PATCH)
Cancela o provisionamento da medição contratual.
/api/measurement/GetMeasurementStatus (GET)
Lista os status possíveis para uma medição. 
/api/measurement/GetByContractId/{contractId} (GET)
Retorna todas medições vinculadas ao contrato.
/api/measurement/GetByKey/{measurementId} (GET)Apresenta as informações da medição.


PARÂMETROS GERAIS

/api/settings (GET)

Essa API retorna  as informações dos parâmetros gerais da base.


PARCEIROS DE NEGÓCIOS

/api/businessPartners (GET)
Retorna os cadastros dos parceiros de negócio cadastrados.

/api/businessPartners/byCodeOrName (GET)

Retorna as informações cadastros dos parceiros de negócio cadastrados pelo código ou nome.


PROVISÕES

/api/classificationProvisionTypes (GET)
Retorna os tipos de provisão cadastrados.


RETENÇÃO TÉCNICA

/api/contractGuaranteePayment (POST)
Realiza o lançamento de uma retenção técnica.
/api/contractGuaranteePayment/{id}/provision (POST)Realiza o provisionamento de uma retenção técnica.
/api/contractGuaranteePayment/{id}/cancel (PUT)
Realiza o cancelamento de uma retenção técnica.
/api/contractGuaranteePayment/{id} (GET)
Consulta a retenção técnica a patir do ID.


UTILIZAÇÕES

/api/fiscalUsages (GET)Realiza a consulta das utilizações cadastradas no sistema.


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