ContractPlus APIs | Consultar Parâmetros Gerais
8 min
Criado por Letícia Gonçalves Ribeiro em 30/01/2025 14:02
Atualizado por Eduardo Martins Dos Santos em 13/02/2025 15:33

Dúvida
Como consultar parâmetros gerais.

/api/settings

 Esta API consulta os parâmetros gerais do ContractPlus vinculados a base de dados, basta executar.


Propriedades

IsMandatoryDimentionOnContract
Obrigar centro de custo no contrato.
LockMeasurementDocDate
Bloquear alteração de data de medição.
TransValidation
Habilitar validação de processo de suprimentos na transaction notification.
CheckUnitMeasureItem
Habilitar validação de unidade de medida de compra e de estoque
AllowProvisionOfRetentionsUnrelated
Permitir provisionar retenções desvinculadas ao sistema.
ShowDownPaysByContract
Na medição exibir somente adiantamentos do contrato.
UseTaxLogon
Usar tax logon.
ContractForceDisapprovalReason
Obrigatório informar um motivo para reprovar contratos.
AdditiveForceDisapprovalReason
Obrigatório informar um motivo para reprovar aditivos.
DownPayForceDisapprovalReason

Obrigatório informar um motivo para reprovar adiantamentos.

DisagreementForceDisapprovalReason 
Obrigatório informar um motivo para reprovar distratos. 
MsrForceDisapprovalReason
Obrigatório informar um motivo para reprovar medições.
GuaranteeForceDisapprovalReason
Obrigatório informar um motivo para reprovar retenções.
AddDestinationDocumentOnApprove
Adicionar documento de destino ao aprovar.
CustomerUsageId
Utilização padrão para cliente.
SupplierUsageId
Utilização padrão para fornecedor.
EnableFreightAdditionalExpenses

Considerar frete como despesa adicional.

ContractFromQuotation
Contratos com base no documento de cotação de vendas.
GroupApportionmentItem

Agrupar itens de rateio no faturamento.

UsageOfFreight
Utilização padrão para frete.
HideHostCenter

Ocultar aba de centro de custo na tela de contrato.

ProjectInContract
Obrigar uso de projeto no contrato.
RestrictContractByProject

Restringir contrato por projeto.

DisagreementForceDisapprovalReason 
Obrigatório informar um motivo para reprovar distratos. 
AllowChangeTaxesApproveMeasurement

Permitir alterar os impostos retidos na medição.

GenerateRetainedTaxProvision
Gerar provisão de impostos retidos.
CreateContractAutomatic
Criar contrato ao criar documento de Marketing.
ActivateContractWhenApproving
Ativar contrato de fornecedor ao aprovar.
ActivateCustomerCntWhenApproving
Ativar contrato de cliente ao aprovar.
LinkDocIntoApprovedMeasurement

Vincular documento em medição aprovada.

ValueToConsiderLowOfDecimalBalance
Valor a considerar baixa de saldo decimal:
ExtendToBillingDate

Prorrogar data de conclusão do contrato para maior data de faturamento ao criar contratos e aditivos.

ReleaseDeliveryWhenApprovingContract
Liberar entrega ao aprovar contrato.
ReleaseDeliveryWhenApprovingAdditive

Liberar entrega ao aprovar aditivo.

 NotCloseContractPendingDocLinked

 Não encerrar o contrato com pendência de documento vinculado.

 ChangeCostCenterOnContractLine Alterar centro de custo na linha após contrato ativo.
 CompanyLogoIdLogotipo selecionada.
 ValueToConsiderLowOfDecimalQuantity Valor a considerar baixa de quantidade decimal:
CashFlowIncludeSupplierContract
Incluir contrato de fornecedor no fluxo de caixa.
CashFlowIncludeSupplierContractDetail

Detalhar lançamento.

CashFlowIncludeCustomerContract

Considerar parâmetro (Liberação de Parcelas) no cadastro de parceiro de negócios

CashFlowIncludeCustomerContractDetail

Detalhar lançamento.

GroupInvoiceByCustomer
Agrupar Nota Fiscal por Cliente no Faturamento do Pedido.
EditContractheaderFields

Editar cabeçalho e linhas do contrato ativo(Projeto, Cond. Pagamento, Forma de pagamento e Responsável).

PurchaseRequestInSAP

 Inserir requisição de compra direta no SAP

UseDocumentApprovalProcess Utilizar o processo de Aprovação de Documento.
CompanyLogoIdLogotipo selecionada.
WhsCodeDefaultDepósito padrão para fornecedor.
DimensionProject
Dimensão do projeto:
WorkPlanRequired

Plano de trabalho obrigatório.

UserViewOnlyOwnDocuments

Permitir que usuários vejam somente suas requisições.

EnableScriptApproval

 Habilitar script de aprovação.

EnableCostCenterInDocuments
Obrigar uso do centro de custo nos documentos de marketing.
EnableUsageMarketingDocuments

Habilitar utilização nos documentos de marketing.

AllowEditPurchaseRequestAndOrderApproved Permitir a edição de documentos de marketing com status Aprovado.
AllowApproverViewReqAndApprovedDoc
Permitir que um aprovador veja todos os documentos solicitados e aprovados.
PurchaseInvoiceDocNumber

ConsiderParameterReleaseInstallment
Considerar parâmetro (Liberação de Parcelas) no cadastro de parceiro de negócios.
UseTaxDeterminationIRFSAP

Utilizar Determinação Impostos Retidos SAP.

ChangeTheDetailsOfTheContract

Alterar os Detalhes Do Contrato.

ChangeWithholdingTaxesInProvision

Alterar impostos retidos no lançamento da provisão da medição.

RestrictContractByClassificationRestringir contrato por classificação.
RestrictCntModificationByClassification

Restringir modificação contratual por classificação. 

GuaranteeTaxDefault

Imposto padrão para retenção.

CloseContractsWithBalance

Permitir encerrar contratos com saldo.

GeneratePurchaseOrderWhenAprovingMsr

Gerar pedido de compra ao aprovar medição.

ConsiderBillingDateOnBilling

Considerar data de faturamento como data do documento e lançamento na liberação e faturamento(Obs: Documentos não agrupados)

UsePriceListToAddProviderContracts

Considerar lista de preços para cadastro de contratos de fornecedor.

UsePriceListToAddCustomerContracts

Considerar lista de preços para cadastro de contratos de cliente.

UsePriceListToAddProviderAdditives

Considerar lista de preços para cadastro de aditivos.

UsePriceListToAddCustomerAdditives

Considerar lista de preços para cadastro de aditivos de cliente.

EnableAutomaticAlternativeNumber

Habilitar número alternativo automático.

ConsiderDueDateOnReleaseInstGroup

Considerar data de vencimento na liberação de parcelas agrupadas.

AllowChooseAcctCode

Permitir selecionar conta contábil de despesa.

ShowBudgetValue

Exibir valor do orçamento para o ano corrente.

DateDeliveryByLeadTime

Entrega com base em LeadTime.

MiniumDaysToRequest

Dias mínimo para solicitação.

EnableItemGroupInBranch

Habilitar grupo de itens por filial.

UseDflWhsBranch

Usar depósito da filial.

EnableContract

Habilitar Contrato Web.

CloseCntWhenAddConclusionDisag

Encerrar contrato sem saldo ao realizar distrato de conclusão.

UseBlockingCenterCost

Utilizar processo de bloqueio e vínculo de usuário por centro de custo.

RestrictAccessByClassification

Restringir acesso por classificação.

RestrictApprovalByClassification

Restringir acesso na aprovação (Aprovações - Adm de Contratos)

RestrictAdditiveByClassification

Restringir aditivo por classificação.

RestrictMeasurementByClassification

Restringir medição por classificação.

RestrictDisagreementByClassification

Restringir distrato por classificação.

RestrictGuaranteeByClassification

Restringir retenção por classificação.

 ReleaseServWhenActiveProviderContract

Liberar serviço ao ativar contrato de fornecedor.

ReleaseServWhenActiveCustomerContract

Liberar serviço ao aprovar aditivo de cliente.

ReleaseServWhenApprovedProviderAdditive

Liberar serviço ao aprovar aditivo de fornecedor.

ReleaseServWhenApprovedCustomerAdditive

Liberar serviço ao aprovar aditivo de cliente.

UseMsrDateAddAsPurchaseOrderDocDate

Utilizar a data de lançamento da medição como data de lançamento e documento do pedido de compra.

MaxDowntime

Tempo de sessão.

AllowCancelPendingPurchaseOrder

Permitir cancelamento de pedido de compra pendente.

AllowCancelPendingPurchaseRequester

Permitir o cancelamento da ordem de solicitação pendente.

EditMeasurementDiscountLine

Permitir alterar desconto na linha da medição.

AllowIncludeItemsInMsrListItems

Permitir incluir itens durante medição contratual (Processo Lista de Itens).

UseGroupNumFromMeasurement

Uti. cond. pag. da medição.

SendClientNameUpdatedToDocMark

Enviar o nome do cliente atualizado buscando do cadastro do parceiro de negócio.

UseUnitContratSale

Considerar unidade do contrato na venda.

CheckIfExistInvoiceWhenBill

Verificar se nota fiscal de saída foi emitida ao realizar faturamento.

ConsiderCalculatedQuantityWhenReleasing

Considerar condição de pagamento da medição ao faturar.

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