Criação de Medição

Requisição

Parâmetros Header

Authorization

string

opcional

Token de acesso obtido no enpoint de Autenticação.

Parâmetros Bodyapplication/json

projectId

string

requerido

Id do projeto onde será associado esta medição

billingType

enum<string>

requerido

Tipo fluxo de Próprio ou Direto

Valores permitidos:

CONSTRUCTORCUSTOMER

Exemplo:

CONSTRUCTOR

measurementDate

string

requerido

Data de aferição desta medição

Exemplo:

2022-08-22

Padrão de combinação:

yyyy-MM-dd

percentageOfContractualRetention

string

requerido

Percentual de retenção contratual. Ex.: 5% - 5

Exemplo:

5

description

string

requerido

Descrição do serviço prestado ou material adiqurido

invoice

object

opcional

Informações da Nota Fiscal

number

string

requerido

Número da Nota Fiscal

fileBase64

string

requerido

Base64 da Nota Fiscal

items

object

requerido

Lista de itens da medição

name

string

requerido

Nome do item da medição

Exemplo:

Tijolo

costCodeId

string

requerido

Código de custo da medição

quantity

string

requerido

Quantidade de itens, permitindo 10 casas decimais

Exemplo:

200.1234567892

unitValue

string

requerido

Valor unitário do item

Exemplo:

10.12

participants

object

requerido

Lista de participantes da medição

measurementId

string

requerido

Id da medição do participante

Exemplo:

example: 1

email

string

requerido

E-mail do participante

Exemplo:

example: test@test.com

name

string

requerido

Nome da pessoa ou empresa

Exemplo:

José da Silva Construções

taxId

string

requerido

CPF/CNPJ do participante (somente números)

Exemplo:

72429723026

role

enum<string>

requerido

Papel desempenhado na medição

Valores permitidos:

EDITORVIEWERSUPPLIER CUSTOMER

Exemplo:

VIEWER

Exemplo

{
  "projectId": 1,
  "billingType": "CONSTRUCTOR",
  "measurementDate": "2022-08-22",
  "percentageOfContractualRetention": 5,
  "description": "Descrição da Medição",
  "invoice": {
    "number": "12345",
    "fileBase64": "string"
  },
  "items": [
    {
      "name": "Tijolo",
      "costCodeId": "10",
      "quantity": 200.1234567892,
      "unitValue": 10.12
    }
  ],
  "participants": [
    {
      "measurementId": 1,
      "email": "test@test.com",
      "name": "José da Silva Construções",
      "taxId": "72429723026",
      "role": "VIEWER"
    }
  ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'api/v1/oneos/measurements' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "projectId": 1,
  "billingType": "CONSTRUCTOR",
  "measurementDate": "2022-08-22",
  "percentageOfContractualRetention": 5,
  "description": "Descrição da Medição",
  "invoice": {
    "number": "12345",
    "fileBase64": "string"
  },
  "items": [
    {
      "name": "Tijolo",
      "costCodeId": "10",
      "quantity": 200.1234567892,
      "unitValue": 10.12
    }
  ],
  "participants": [
    {
      "measurementId": 1,
      "email": "test@test.com",
      "name": "José da Silva Construções",
      "taxId": "72429723026",
      "role": "VIEWER"
    }
  ]
}'

Respostas

🟢200Success

application/json

Body

id

string

requerido

Id da medição

Exemplo:

1

projectId

string

requerido

Id do projeto onde será associado esta medição

Exemplo:

1

billingType

string

requerido

Tipo fluxo de pagamento da medição

Exemplo:

CONSTRUCTOR

status

string

requerido

Status da medição

Exemplo:

DRAFT

process

string

requerido

Status do processo da medição

Exemplo:

COMPLETE

measurementDate

string

requerido

Data de aferição desta medição

Exemplo:

2022-08-22

measurementNumber

string

requerido

Número de medição calculada a partir de Empresa-Projeto-Fornecedor

Exemplo:

1

percentageOfContractualRetention

string

requerido

Percentual de retenção contratual

Exemplo:

0.05

description

string

requerido

Descrição da medição

Exemplo:

Descrição da medição

items

object

requerido

name

string

requerido

Nome do item da medição

Exemplo:

Tijolo

costCodeId

string

requerido

Código de custo da medição

Exemplo:

10

quantity

string

requerido

Quantidade de itens, permitindo 10 casas decimais

Exemplo:

200.1234567892

unitValue

string

requerido

Valor unitário do item

Exemplo:

10.12

id

string

requerido

Identificador da medição

Exemplo:

1

amount

string

requerido

Valor total do item da medição

Exemplo:

1000.25

costCodeName

string

requerido

Nome do Código de Custo

Exemplo:

Almoxarifado

participants

object

requerido

measurementId

string

opcional

Id da medição do participante

Exemplo:

1

email

string

requerido

E-mail do participante

Exemplo:

example: test@test.com

name

string

requerido

Nome da pessoa ou empresa

Exemplo:

José da Silva Construções

taxId

string

requerido

CPF/CNPJ do participante (somente números)

Exemplo:

72429723026

role

string

requerido

Papel desempenhado na medição

Exemplo:

VIEWER

id

string

requerido

Id do usuário

Exemplo:

1

jobRoleName

string

requerido

Cargo desempenhado na empresa

Exemplo:

SITE_MANAGER

withholdingTaxes

object

requerido

id

integer

requerido

Id da retenção fiscal

Exemplo:

1

name

string

requerido

Descrição da retenção fiscal

aliquot

number

requerido

Alíquota da retenção fiscal (valor fracionado)

nominalAliquot

number

requerido

Alíquota da retenção fiscal (valor nominal em %, duas casas decimais)

calculationBasis

number

requerido

Base de cálculo da retenção fiscal (valor fracionado)

nominalCalculationBasis

number

requerido

Base de cálculo da retenção fiscal (valor nominal em %, duas casas decimais)

amount

number

requerido

Valor da retenção fiscal

invoice

object

requerido

number

string

requerido

Número da NF

file

string

requerido

Conteúdo do arquivo em Base64

contentType

string

requerido

Formato do arquivo

financialSummary

object

requerido

Resumo financeiro da medição

measurementId

string

requerido

Id da medição

measurementAmount

string

requerido

Valor medido (soma de todos os itens da medição)

releasedMeasurementAmount

string

requerido

Valor liberado da medição (valor medido - retenção contratual)

finalMeasurementAmount

string

requerido

Valor final da medição (valor liberado - retenções fiscais)

measurementAmountPaid

string

requerido

Valor que já foi pago da medição

withholdingTaxesTotalAmount

string

requerido

Valor total das retenções fiscais

withholdingTaxesTotalAmountPaid

string

requerido

Valor total, que já foi pago, das retenções fiscais

contractualRetentionPercent

string

requerido

Percentual da retenção contratual

contractualRetentionAmount

string

requerido

Valor da retenção contratual

managers

object

requerido

Lista de participantes que podem visualizar e que são gestores da empresa

measurementId

string

requerido

Id da medição do participante

email

string

requerido

E-mail do participante

taxId

string

requerido

CPF/CNPJ do participante (somente números)

role

string

requerido

Papel desempenhado na medição

id

string

requerido

Id do usuário

jobRoleName

string

requerido

Cargo desempenhado na empresa

Exemplo

{
    "id": 1,
    "projectId": 1,
    "billingType": "CONSTRUCTOR",
    "status": "DRAFT",
    "process": "COMPLETE",
    "measurementDate": "2022-08-22",
    "measurementNumber": "1",
    "percentageOfContractualRetention": "0.05",
    "description": "Descricao da medição",
    "items": [
        {
            "name": "Tijolo",
            "costCodeId": "10",
            "quantity": 200.1234567892,
            "unitValue": 10.12,
            "id": 1,
            "amount": 1000.25,
            "costCodeName": "Almoxarifado"
        }
    ],
    "participants": [
        {
            "measurementId": 1,
            "email": "test@test.com",
            "name": "José da Silva Construções",
            "taxId": "72429723026",
            "role": "VIEWER",
            "id": 1,
            "jobRoleName": "SITE_MANAGER"
        }
    ],
    "withholdingTaxes": [
        {
            "id": 0,
            "name": "string",
            "aliquot": 0.0656,
            "nominalAliquot": 6.56,
            "calculationBasis": 0.0321,
            "nominalCalculationBasis": 3.21,
            "amount": 27.15
        }
    ],
    "invoice": {
        "number": "12345",
        "file": "string",
        "contentType": "application/pdf"
    },
    "financialSummary": {
        "measurementId": 0,
        "measurementAmount": 0,
        "releasedMeasurementAmount": 0,
        "finalMeasurementAmount": 0,
        "measurementAmountPaid": 0,
        "withholdingTaxesTotalAmount": 0,
        "withholdingTaxesTotalAmountPaid": 0,
        "contractualRetentionPercent": 0,
        "contractualRetentionAmount": 0
    },
    "managers": [
        {
            "measurementId": 1,
            "email": "test@test.com",
            "name": "José da Silva Construções",
            "taxId": "72429723026",
            "role": "VIEWER",
            "id": 1,
            "jobRoleName": "SITE_MANAGER"
        }
    ]
}