API Pública

Atualizar composição (Modelo SINAPI)

Production Env

https://api.orcafascio.com/api

PUT

/v1/base/mybase/compositions/{{sinapi_composition_id}}

Última modificação:2024-04-10 19:36:25

Responsável:Higor Melo

Requisição

Parâmetros Header

Authorization

string

requerido

Token gerado pelo OrçaFascio

Exemplo:

Parâmetros Bodyapplication/json

code

string

requerido

Código da composição

second_code

string

requerido

Código dois da composição "Opcional"

description

string

requerido

Descrição da composição

labor

boolean

requerido

Mão de Obra da composição

type

string

requerido

Tipo da composição

unit

string

requerido

Unidade da composição

local

string

requerido

Estado da composição

rounding_type

integer

requerido

Método de calculo da composição

is_sicro

boolean

requerido

Modo da composição (SINAPI: false | SICRO: true)

note

string

requerido

Observação da composição

Exemplo

{
    "code": "00000005",
    "second_code": "API-005",
    "description": "BARRACAO PARA DEPOSITO EM TABUAS DE MADEIRA, COBERTURA EM FIBROCIMENTO 4 MM, INCLUSO PISO ARGAMASSA TRAÇO 1:6",
    "labor": false,
    "type": "CANT",
    "unit": "m²",
    "local": "SP",
    "rounding_type": 2,
    "is_sicro": false,
    "reference": "10/2023",
    "note": "Composição modelo SINAPI tipo CANTEIRO DE OBRA"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PUT 'https://api.orcafascio.com/api/v1/base/mybase/compositions/{{sinapi_composition_id}}' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "00000005",
    "second_code": "API-005",
    "description": "BARRACAO PARA DEPOSITO EM TABUAS DE MADEIRA, COBERTURA EM FIBROCIMENTO 4 MM, INCLUSO PISO ARGAMASSA TRAÇO 1:6",
    "labor": false,
    "type": "CANT",
    "unit": "m²",
    "local": "SP",
    "rounding_type": 2,
    "is_sicro": false,
    "reference": "10/2023",
    "note": "Composição modelo SINAPI tipo CANTEIRO DE OBRA"
}'

Respostas

🟢200Success

application/json

Body

string

requerido

ID da composicão

company_id

string

requerido

ID da empresa

user_id

string

requerido

ID da usuário "dono"

department_id

string

requerido

ID do setor

code

string

requerido

Código da composicão

second_code

string

requerido

Segundo código do insumo "Opcional"

description

string

requerido

Descrição da composicão

type

string

requerido

Tipo da composicão

unit

string

requerido

Unidade da composicão

state

string

requerido

Estado da composição

is_sicro

boolean

requerido

Modelo da composição (SINAPI: false | SICRO: true)

calculation_method

object

requerido

Método de calculo

type

integer

requerido

Tipo do método

description

string

requerido

Descrição do método

labor

boolean

requerido

Mão de obra da composição

prices

object

requerido

Preços

banks

object

requerido

Bancos de referência

SINAPI

object

requerido

Nome do banco de referência

items

array [object]

requerido

Items auxiliares da composição

created_at

string

requerido

Data de criação da composição

Exemplo

{
    "id": "65e877fef4319730ab1b78d6",
    "company_id": "62683e8363051f543020cfe5",
    "user_id": "62683e8363051f543020cfe9",
    "department_id": "62683e8363051f543020cfe8",
    "code": "00000005",
    "second_code": "API-005",
    "description": "BARRACAO PARA DEPOSITO EM TABUAS DE MADEIRA, COBERTURA EM FIBROCIMENTO 4 MM, INCLUSO PISO ARGAMASSA TRAÇO 1:6",
    "type": "CANT",
    "unit": "m²",
    "state": "SP",
    "is_sicro": false,
    "calculation_method": {
        "type": 2,
        "description": "Arredondar em 2 casas decimais"
    },
    "labor": false,
    "prices": null,
    "banks": {
        "SINAPI": {
            "data": "12/2023",
            "estado": "SP",
            "relatorio": true
        }
    },
    "items": [],
    "created_at": "2024-03-06T11:04:47.008-03:00"
}

🟠401Not authorized

🟠404Not found

🔴500Internal server error

Página anterior

Criar composição (Melo SICRO)

Próxima página

Atualizar composição (Modelo SICRO)