Dúvida
Importação de contratos via Webhook.
Requisitos
Antes de tudo é preciso verificar alguns requisitos básicos para o procedimento.
Importante |
Certifique se de que o Add-on e Monitor de Serviços estejam na versão 24.7.3.37302 em diante. |
1. Parâmetros gerais:
Acesse Módulos → ContractPlus → Configuração → Parâmetros gerais .
Na aba “Contract Web” preencha os campos Id e HookName .
-No campo “HookName” preencha com o nome previamente fornecido por nossa equipe.
-No campo “HookId” preencha com o Id previamente fornecido por nossa equipe.
2. Monitor de serviços:
Certifique-se que o Monitor de Serviços ContractPlus está previamente configurado e em execução. Para mais informaçõesclique aqui.
É necessário que os três serviços abaixo estejam em execução:
Procedimento
1. No Postman, clique no menu “Post Message’’, na aba "Body" copie e cole o Json no campo.
| Nota | ||||||
Ao final deste artigo, disponibilizamos um exemplo de JSON para contrato de Clientes e outro para contrato de Fornecedores. |
E preencha os dois primeiros campos com o seu Id e o hookName.
3. Preencha os restantes dos campos. É fundamental que os campos sejam preenchidos corretamente de acordo com sua base e banco de dados.
Veja o exemplo abaixo, iremos criar um contrato com o N. Alternativo “ Teste WebHook” com o tipo de contrato “Vendas”.
Após preencher todos os campos corretamente clique em ”Send”.
4. Você pode acompanhar sua importação por meio do gerente de importações, acesse ContractPlus → Importação → Importação de Contratos → Gerente de Importação.
No cabeçalho, caso prefira, filtre pela data inicial do contrato e verifique o status da importação.
Observação |
Caso não encontre o seu contrato no gerente de importação verifique em ContractPlus → Importação → Importação de Contratos → Log de Importação. |
5. Após o contrato importado com sucesso acesse a tela de gerenciamento de contratos.
Veja que o contrato criado por meio do Json já esta disponível para gestão.
Caso envie o JSON com o mesmo número alternativo, de um contrato que possua um status "Ativo", será gerado um aditivo contratual.
Exemplo de JSON para contratos de cliente:
{
"id": "653eeab9-3111-4811-8b31-9cabd797N879",
"hookName": "Contract",
"contracts": [
{
"companyId": 1, //Empresa
"cardCode": "CL00003", //Código de parceiro
"cardName": "CLIENTE TESTE", //Nome do parceiro
"dateConclusion": "2030-05-01", // Data de conclusão
"dateStart": "2025-05-01", //Data de início do contrato
"projectId": "", //Código do projeto
"slpCode": 3, //Responsável
"groupNum": 7, //Condição de pagamento
"classificationId": 31, //Classificação do contrato
"contractTypeId": 2, //Tipo de contrato
"alternateNumber": "TESTE-CLIENTE-250528-1", //N. Alternativo
"paymentMethod": "TES_23", //Método de pagamento
"comments": "TESTETAREFA", //Observação
"header": "", //Observações iniciais
"footer": "", //Observações Finais
"currency": "R$", //Moeda
"proBonoRelationShip": false, //Relação pro bono (Aba Detalhes do contrato)
"expensesRefund": false, //Permitir reembolso de despesas (Aba detalhes do contrato)
"objectOfTheContract": "", //Objeto de contrato (Aba detalhes do contrato)
"fine": "", //Multa (aba detalhes do contrato)
"allowAdvance": false, //Permitir adiantamento (Aba detalhes do contrato)
"royalties": false, //Royalties (Aba Detalhes do contrato)
"royaltiesDesc": "", //Royalties Desc. (Aba Detalhes do contrato)
"docEntrySbo": 0, //Documento de origem
"objTypeSbo": 0, //Tipo de documento de origem
"productSaleReportType": 2, //Informativo de venda padrão
"userFields": "{\"\": \"\"}", //Campos de usuário cabeçalho
"lines": [
{
"treeType": 0, //Estrutura
"itemCode": "SER000016", //Código do ítem
"itemName": "Item Parcelado", //Nome do ítem
"quantity": 12, //Quantidade
"quantityHired": 0, //Quantidade de ítens (ENTREGA)
"priceUnit": 100000, //Preço Unitário
"billingType": 2, //Faturamento (1-Medição/ 2-Parcelado /3-Recorrente /4-Calculado /5-Parcelado Medido)
"calculationTypeId": 0, //Tipo de cálculo
"recurrenceType": 2, //Tipo de recorrência
"installmentsTotal": 12, //Parcelas
"referenceDate": "2025-05-01", //Referência Inicial
"dueDateBase": "2025-05-01", ////Vencimento Base
"birthdayDate": "2030-10-10", //Aniversário da linha
"inicialBalance": 0,
"usageId": 10, //Utilização padrão
"measureUnitId": "Und", //Unidade
"ocrCode": "", //Centro de custo 1
"ocrCode2": "", //Centro de custo 2
"ocrCode3": "", //Centro de custo 3
"ocrCode4": "", //Centro de custo 4
"ocrCode5": "", //Centro de custo 5
"whsCode": "01", //Depósito
"objectOfTheContract": "", //Objeto de contrato
"quotationLineNum": 0,
"prjCode": "", //Projeto
"slpCode": 0, //Responsável
"financialIndexId": 0, //Índice financeiro
"readjustmentValueType": 0, //Tipo de valor de reajuste
"billingMonth": 0,
"billingDay": 0,
"measurementById": 1, //Tipo de medição
"effectiveDate": "2025-12-31", //Vigência para linhas do rateio
"saleReportValueSource": 0, //Origem do valor do info. de venda
"saleRepRangeType": 0, //Calcular o fat. aplicando percentual para: (Tipo de intervalo de valor)
"saleReportValueBase": 0,
"userFields": "{\"\": \" \"}", //Campos de usuário da linha do ítem
"apportionments": [], //Rateio
"saleRepRanges": [] //Intervalos de faturamento por percentual
},
{
"treeType": 0, //Estrutura
"itemCode": "SER000017", //Código do ítem
"itemName": "Item Recorrente", //Nome do ítem
"quantity": 12, //Quantidade
"quantityHired": 0, //Quantidade de ítens (ENTREGA)
"priceUnit": 100000, //Preço Unitário
"billingType": 3, //Faturamento (1-Medição/ 2-Parcelado /3-Recorrente /4-Calculado /5-Parcelado Medido)
"calculationTypeId": 0, //Tipo de cálculo
"recurrenceType": 2, //Tipo de recorrência
"installmentsTotal": 12, //Parcelas
"referenceDate": "2025-05-01", //Referência Inicial
"dueDateBase": "2025-05-01", ////Vencimento Base
"birthdayDate": "2030-10-10", //Aniversário da linha
"inicialBalance": 0,
"usageId": 10, //Utilização padrão
"measureUnitId": "Und", //Unidade
"ocrCode": "", //Centro de custo 1
"ocrCode2": "", //Centro de custo 2
"ocrCode3": "", //Centro de custo 3
"ocrCode4": "", //Centro de custo 4
"ocrCode5": "", //Centro de custo 5
"whsCode": "01", //Depósito
"objectOfTheContract": "", //Objeto de contrato
"quotationLineNum": 0,
"prjCode": "", //Projeto
"slpCode": 0, //Responsável
"financialIndexId": 0, //Índice financeiro
"readjustmentValueType": 0, //Tipo de valor de reajuste
"billingMonth": 0,
"billingDay": 0,
"measurementById": 1, //Tipo de medição
"effectiveDate": "2025-12-31", //Vigência para linhas do rateio
"saleReportValueSource": 0, //Origem do valor do info. de venda
"saleRepRangeType": 0, //Calcular o fat. aplicando percentual para: (Tipo de intervalo de valor)
"saleReportValueBase": 0,
"userFields": "{\"\": \" \"}", //Campos de usuário da linha do ítem
"apportionments": [], //Rateio
"saleRepRanges": [] //Intervalos de faturamento por percentual
},
{
"treeType": 0, //Estrutura
"itemCode": "SER000018", //Código do ítem
"itemName": "Item Medição", //Nome do ítem
"quantity": 12, //Quantidade
"quantityHired": 0, //Quantidade de ítens (ENTREGA)
"priceUnit": 100000, //Preço Unitário
"billingType": 1, //Faturamento (1-Medição/ 2-Parcelado /3-Recorrente /4-Calculado /5-Parcelado Medido)
"calculationTypeId": 0, //Tipo de cálculo
"recurrenceType": 1, //Tipo de recorrência
"installmentsTotal": 0, //Parcelas
"referenceDate": "2025-05-01", //Referência Inicial
"dueDateBase": "2025-05-01", ////Vencimento Base
"birthdayDate": "2030-10-10", //Aniversário da linha
"inicialBalance": 0,
"usageId": 10, //Utilização padrão
"measureUnitId": "Und", //Unidade
"ocrCode": "", //Centro de custo 1
"ocrCode2": "", //Centro de custo 2
"ocrCode3": "", //Centro de custo 3
"ocrCode4": "", //Centro de custo 4
"ocrCode5": "", //Centro de custo 5
"whsCode": "01", //Depósito
"objectOfTheContract": "", //Objeto de contrato
"quotationLineNum": 0,
"prjCode": "", //Projeto
"slpCode": 0, //Responsável
"financialIndexId": 0, //Índice financeiro
"readjustmentValueType": 0, //Tipo de valor de reajuste
"billingMonth": 0,
"billingDay": 0,
"measurementById": 1, //Tipo de medição
"effectiveDate": "2025-12-31", //Vigência para linhas do rateio
"saleReportValueSource": 0, //Origem do valor do info. de venda
"saleRepRangeType": 0, //Calcular o fat. aplicando percentual para: (Tipo de intervalo de valor)
"saleReportValueBase": 0,
"userFields": "{\"\": \" \"}", //Campos de usuário da linha do ítem
"apportionments": [], //Rateio
"saleRepRanges": [] //Intervalos de faturamento por percentual
}
],
"representatives": [] //Representantes
}
]
}
{
"id": "653eeab9-3111-4811-8b31-9cabd797N879",
"hookName": "Contract",
"contracts": [
{
"companyId": 1, //Empresa
"cardCode": "F00002", //Código de parceiro
"cardName": "FORNECEDOR 123", //Nome do parceiro
"dateConclusion": "2030-05-01", // Data de conclusão
"dateStart": "2025-05-01", //Data de início do contrato
"projectId": "", //Código do projeto
"slpCode": 3, //Responsável
"groupNum": 7, //Condição de pagamento
"classificationId": 31, //Classificação do contrato
"contractTypeId": 2, //Tipo de contrato
"alternateNumber": "TESTE-FORNECEDOR-250528-1", //N. Alternativo
"paymentMethod": "TES_23", //Método de pagamento
"comments": "TESTETAREFA", //Observação
"header": "", //Observações iniciais
"footer": "", //Observações Finais
"currency": "R$", //Moeda
"proBonoRelationShip": false, //Relação pro bono (Aba Detalhes do contrato)
"expensesRefund": false, //Permitir reembolso de despesas (Aba detalhes do contrato)
"objectOfTheContract": "", //Objeto de contrato (Aba detalhes do contrato)
"fine": "", //Multa (aba detalhes do contrato)
"allowAdvance": false, //Permitir adiantamento (Aba detalhes do contrato)
"royalties": false, //Royalties (Aba Detalhes do contrato)
"royaltiesDesc": "", //Royalties Desc. (Aba Detalhes do contrato)
"docEntrySbo": 0, //Documento de origem
"objTypeSbo": 0, //Tipo de documento de origem
"productSaleReportType": 2, //Informativo de venda padrão
"userFields": "{\"\": \"\"}", //Campos de usuário cabeçalho
"lines": [
{
"treeType": 0, //Estrutura
"itemCode": "SER000016", //Código do ítem
"itemName": "Item Parcelado", //Nome do ítem
"quantity": 12, //Quantidade
"quantityHired": 0, //Quantidade de ítens (ENTREGA)
"priceUnit": 100000, //Preço Unitário
"billingType": 2, //Faturamento (1-Medição/ 2-Parcelado /3-Recorrente /4-Calculado /5-Parcelado Medido)
"calculationTypeId": 0, //Tipo de cálculo
"recurrenceType": 2, //Tipo de recorrência
"installmentsTotal": 12, //Parcelas
"referenceDate": "2025-05-01", //Referência Inicial
"dueDateBase": "2025-05-01", ////Vencimento Base
"birthdayDate": "2030-10-10", //Aniversário da linha
"inicialBalance": 0,
"usageId": 10, //Utilização padrão
"measureUnitId": "Und", //Unidade
"ocrCode": "", //Centro de custo 1
"ocrCode2": "", //Centro de custo 2
"ocrCode3": "", //Centro de custo 3
"ocrCode4": "", //Centro de custo 4
"ocrCode5": "", //Centro de custo 5
"whsCode": "01", //Depósito
"objectOfTheContract": "", //Objeto de contrato
"quotationLineNum": 0,
"prjCode": "", //Projeto
"slpCode": 0, //Responsável
"financialIndexId": 0, //Índice financeiro
"readjustmentValueType": 0, //Tipo de valor de reajuste
"billingMonth": 0,
"billingDay": 0,
"measurementById": 1, //Tipo de medição
"effectiveDate": "2025-12-31", //Vigência para linhas do rateio
"saleReportValueSource": 0, //Origem do valor do info. de venda
"saleRepRangeType": 0, //Calcular o fat. aplicando percentual para: (Tipo de intervalo de valor)
"saleReportValueBase": 0,
"userFields": "{\"\": \" \"}", //Campos de usuário da linha do ítem
"apportionments": [], //Rateio
"saleRepRanges": [] //Intervalos de faturamento por percentual
},
{
"treeType": 0, //Estrutura
"itemCode": "SER000017", //Código do ítem
"itemName": "Item Recorrente", //Nome do ítem
"quantity": 12, //Quantidade
"quantityHired": 0, //Quantidade de ítens (ENTREGA)
"priceUnit": 100000, //Preço Unitário
"billingType": 3, //Faturamento (1-Medição/ 2-Parcelado /3-Recorrente /4-Calculado /5-Parcelado Medido)
"calculationTypeId": 0, //Tipo de cálculo
"recurrenceType": 2, //Tipo de recorrência
"installmentsTotal": 12, //Parcelas
"referenceDate": "2025-05-01", //Referência Inicial
"dueDateBase": "2025-05-01", ////Vencimento Base
"birthdayDate": "2030-10-10", //Aniversário da linha
"inicialBalance": 0,
"usageId": 10, //Utilização padrão
"measureUnitId": "Und", //Unidade
"ocrCode": "", //Centro de custo 1
"ocrCode2": "", //Centro de custo 2
"ocrCode3": "", //Centro de custo 3
"ocrCode4": "", //Centro de custo 4
"ocrCode5": "", //Centro de custo 5
"whsCode": "01", //Depósito
"objectOfTheContract": "", //Objeto de contrato
"quotationLineNum": 0,
"prjCode": "", //Projeto
"slpCode": 0, //Responsável
"financialIndexId": 0, //Índice financeiro
"readjustmentValueType": 0, //Tipo de valor de reajuste
"billingMonth": 0,
"billingDay": 0,
"measurementById": 1, //Tipo de medição
"effectiveDate": "2025-12-31", //Vigência para linhas do rateio
"saleReportValueSource": 0, //Origem do valor do info. de venda
"saleRepRangeType": 0, //Calcular o fat. aplicando percentual para: (Tipo de intervalo de valor)
"saleReportValueBase": 0,
"userFields": "{\"\": \" \"}", //Campos de usuário da linha do ítem
"apportionments": [], //Rateio
"saleRepRanges": [] //Intervalos de faturamento por percentual
},
{
"treeType": 0, //Estrutura
"itemCode": "SER000018", //Código do ítem
"itemName": "Item Medição", //Nome do ítem
"quantity": 12, //Quantidade
"quantityHired": 0, //Quantidade de ítens (ENTREGA)
"priceUnit": 100000, //Preço Unitário
"billingType": 1, //Faturamento (1-Medição/ 2-Parcelado /3-Recorrente /4-Calculado /5-Parcelado Medido)
"calculationTypeId": 0, //Tipo de cálculo
"recurrenceType": 1, //Tipo de recorrência
"installmentsTotal": 0, //Parcelas
"referenceDate": "2025-05-01", //Referência Inicial
"dueDateBase": "2025-05-01", ////Vencimento Base
"birthdayDate": "2030-10-10", //Aniversário da linha
"inicialBalance": 0,
"usageId": 10, //Utilização padrão
"measureUnitId": "Und", //Unidade
"ocrCode": "", //Centro de custo 1
"ocrCode2": "", //Centro de custo 2
"ocrCode3": "", //Centro de custo 3
"ocrCode4": "", //Centro de custo 4
"ocrCode5": "", //Centro de custo 5
"whsCode": "01", //Depósito
"objectOfTheContract": "", //Objeto de contrato
"quotationLineNum": 0,
"prjCode": "", //Projeto
"slpCode": 0, //Responsável
"financialIndexId": 0, //Índice financeiro
"readjustmentValueType": 0, //Tipo de valor de reajuste
"billingMonth": 0,
"billingDay": 0,
"measurementById": 1, //Tipo de medição
"effectiveDate": "2025-12-31", //Vigência para linhas do rateio
"saleReportValueSource": 0, //Origem do valor do info. de venda
"saleRepRangeType": 0, //Calcular o fat. aplicando percentual para: (Tipo de intervalo de valor)
"saleReportValueBase": 0,
"userFields": "{\"\": \" \"}", //Campos de usuário da linha do ítem
"apportionments": [], //Rateio
"saleRepRanges": [] //Intervalos de faturamento por percentual
}
],
"representatives": [] //Representantes
}
]
}