Brik API
  1. Medição
Brik API
  • Introdução
    • Integração Brik
    • Visão Geral da API Rest
    • Ciclo de Vida da API
  • Ambiente
    • Ambiente
  • Autenticação
    • Gerando Chaves de Acesso
    • Autenticando-se
    • Token de Acesso
      POST
  • Projetos
    • Entendendo Projetos
    • Criação de Projeto
      POST
  • Medição
    • Entendendo a Medição
    • Criação de Medição
      POST
    • Consulta de Impostos da Empresa
      GET
    • Adição de Retenções Fiscais em uma Medição
      POST
    • Criação de Parcela em Medição
      POST
    • Validação das Parcelas
      POST
    • Validação da Medição
      PATCH
    • Mudança de Status da Medição
      PATCH
  • Contas a Pagar
    • Entendendo o Contas a Pagar
    • Adicinar Comprovante de Pagamento em Parcela
      POST
  • Fluxo Financeiro
    • Entendendo o Fluxo Financeiro
  • Webhooks
    • Entendendo o Payload
    • Eventos
      • Utilizando Webhooks
      • Criação de Medição
      • Atualização de Medição
      • Criação e Atualização de Parcela
      • Criação e Atualização de Fluxo Financeiro
  1. Medição

Criação de Medição

POST
api/v1/oneos/measurements
Endpoint para criação de medição

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

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"
    }
  ]
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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

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"
        }
    ]
}
Modificado em 2024-04-10 19:03:10
Página anterior
Entendendo a Medição
Próxima página
Consulta de Impostos da Empresa
Built with