❓ Dúvida
Como realizar o provisionamento de uma medição.
A API responsável por realizar o provisionamento é:
/api/measurement/PaymentProvisioning
⚠️ Informação Importante
Para realizar o provisionamento de uma medição é necessário que alguns passos tenham sido atendidos
- O contrato utilizado deve estar aprovado, ativo e com seus itens devidamente liberados.
- A medição a ser provisionada deve estar lançada e com status "Aprovada".
- Caso o parâmetro "Gerar pedido de compra ao aprovar medição" esteja ativo e o pedido passe por modelo de aprovação, será necessário aprovar o pedido de compra.
📝 Modelo do JSON utilizado:
{
"MeasurementId": 6883,
"CardCode": "F00002",
"CardName": "FORNECEDOR 123",
"TaxDate": "2025-08-18T15:44:31.0271931-03:00",
"DocDueDate": "2025-08-15T00:00:00",
"SeqCode": -2,
"Project": "QA",
"DocCurrency": "R$",
"DocDate": "2025-08-18T15:44:31.0271931-03:00",
"GroupNum": 15,
"Lines": [
{
"ItemCode": "SER000016",
"Description": "Item Parcelado",
"Usage": 3,
"Quantity": 1,
"UnitPrice": 2345.23,
"LineTotal": 2345.23,
"WhsCode": "01",
"ProjectCode": "QA",
"WithholdingTaxes": [],
"MeasurementLineId": 9832,
"TaxCode": "1101-001",
"OcrCode": "1.002",
"OcrCode2": "2.001",
"OcrCode3": "3.001",
"OcrCode4": "4.001",
"OcrCode5": "5.001"
},
{
"ItemCode": "SER000017",
"Description": "Item Recorrente",
"Usage": 3,
"Quantity": 1,
"UnitPrice": 41476.08,
"LineTotal": 41476.08,
"WhsCode": "01",
"ProjectCode": "QA",
"WithholdingTaxes": [],
"MeasurementLineId": 9833,
"TaxCode": "1101-001",
"OcrCode": "1.002",
"OcrCode2": "2.001",
"OcrCode3": "3.001",
"OcrCode4": "4.001",
"OcrCode5": "5.001"
},
{
"ItemCode": "SER000018",
"Description": "Item Medição",
"Usage": 3,
"Quantity": 1,
"UnitPrice": 1234.12,
"LineTotal": 1234.12,
"WhsCode": "01",
"ProjectCode": "QA",
"WithholdingTaxes": [],
"MeasurementLineId": 9834,
"TaxCode": "1101-001",
"OcrCode": "1.002",
"OcrCode2": "2.001",
"OcrCode3": "3.001",
"OcrCode4": "4.001",
"OcrCode5": "5.001"
},
{
"ItemCode": "SER000018",
"Description": "Item Medição",
"Usage": 3,
"Quantity": 1,
"UnitPrice": 1480.944,
"LineTotal": 1480.944,
"WhsCode": "01",
"ProjectCode": "QA",
"WithholdingTaxes": [],
"MeasurementLineId": 9835,
"TaxCode": "1101-001",
"OcrCode": "1.002",
"OcrCode2": "2.001",
"OcrCode3": "3.001",
"OcrCode4": "4.001",
"OcrCode5": "5.001"
},
{
"ItemCode": "SER000018",
"Description": "Item Medição",
"Usage": 3,
"Quantity": 2,
"UnitPrice": 1234.12,
"LineTotal": 2468.24,
"WhsCode": "01",
"ProjectCode": "QA",
"WithholdingTaxes": [],
"MeasurementLineId": 9836,
"TaxCode": "1101-001",
"OcrCode": "1.002",
"OcrCode2": "2.001",
"OcrCode3": "3.001",
"OcrCode4": "4.001",
"OcrCode5": "5.001"
},
{
"ItemCode": "SER000020",
"Description": "Item Parcelado Medido",
"Usage": 3,
"Quantity": 1,
"UnitPrice": 54809.4,
"LineTotal": 54809.4,
"WhsCode": "01",
"ProjectCode": "QA",
"WithholdingTaxes": [],
"MeasurementLineId": 9837,
"TaxCode": "1101-001",
"OcrCode": "1.002",
"OcrCode2": "2.001",
"OcrCode3": "3.001",
"OcrCode4": "4.001",
"OcrCode5": "5.001"
}
],
"AttachmentEntry": 0,
"Installments": [],
"InstallmentId": 0,
"TypeFreight": "2",
"SeriesStr": "123",
"Serial": "321",
"Comments": "Teste API Postman",
"PaymentMethod": "Cartão"
}🛠️ Procedimento
Preencha o JSON no campo “Request Body” e execute a API.
Se a inserção da provisão for realizada com sucesso, a mensagem "true" será exibido no campo Response Body.
📄 Resultado
- A medição passa a ter o status "Pagamento Provisionado"
- Um documento de marketing é automaticamente gerado a partir do provisionamento da medição (Nota Fiscal de Entrada).
📘 Documentação dos Campos – JSON de Provisionamento de Medição
Identificação do Documento
MeasurementId – Id da Medição
SeriesStr – Série do Documento
Serial – Número do Documento
Parceiro de Negócio
CardCode – Código do Fornecedor
CardName – Nome do Fornecedor
Datas
TaxDate – Data de Lançamento
DocDate – Data do Documento
DocDueDate – Data de Vencimento
Dados Gerais
SeqCode – Código Sequencial
Project – Projeto Vinculado
DocCurrency – Moeda do Documento
GroupNum – Condição de Pagamento
PaymentMethod – Forma de Pagamento
TypeFreight – Modalidade de Frete
Comments – Observações / Comentários
AttachmentEntry – Anexo Vinculado (se houver)
Installments – Parcelas de Pagamento
InstallmentId – Identificador da Parcela
📦 Estrutura das Linhas (Lines)
Cada objeto dentro de Lines representa um item da medição.
ItemCode – Código do Item
Description – Descrição do Item
Usage – Tipo de Uso do Item
Quantity – Quantidade
UnitPrice – Valor Unitário
LineTotal – Valor Total da Linha (UnitPrice × Quantity)
WhsCode – Código do Depósito
ProjectCode – Projeto vinculado ao Item
WithholdingTaxes – Impostos Retidos aplicados ao Item
MeasurementLineId – Identificador da Linha de Medição
TaxCode – Código de Imposto aplicado
OcrCode – Centro de Custo Nível 1
OcrCode2 – Centro de Custo Nível 2
OcrCode3 – Centro de Custo Nível 3
OcrCode4 – Centro de Custo Nível 4
OcrCode5 – Centro de Custo Nível 5