API Pública
HomeSuporte Técnico
HomeSuporte Técnico
Instagram
  1. Composições
  • Iniciando a integração
    • Introdução
    • Iniciando
    • Erros
    • Catálogo de tipo e unidade das base de referência
  • OrçaFascio API
    • v1
      • Autenticação
        • Login
      • Grupos
        • Listar grupos
        • Consultar grupo
        • Criar grupo
        • Atualizar grupo
        • Deletar grupo
      • Insumos
        • Listar insumos
        • Consultar por código
        • Criar insumo
        • Atualizar insumo
        • Deletar insumo
      • Composições
        • Listar composições
          GET
        • Consultar composiçao
          GET
        • Consultar composição por código
          GET
        • Criar Composição (Modelo SINAPI)
          POST
        • Criar composição (Melo SICRO)
          POST
        • Atualizar composição (Modelo SINAPI)
          PUT
        • Atualizar composição (Modelo SICRO)
          PUT
        • Deletar composição
          DELETE
        • Editar Bancos
          POST
        • Adicionar itens da composição
          POST
        • Remover itens da composição
          DELETE
      • Orçamentos
        • Listar orçamentos
      • Relatórios
        • Sintético
        • Composições Analíticas com Preço Unitário
  1. Composições

Editar Bancos

Production Env
https://api.orcafascio.com/api
Production Env
https://api.orcafascio.com/api
POST
https://api.orcafascio.com/api
/v1/base/mybase/compositions/{{sinapi_composition_id}}/add_bases
Última modificação:2024-04-10 19:36:56
Responsável:Higor Melo

Requisição

Parâmetros Header
Authorization
string 
requerido
Token gerado pelo OrçaFascio
Exemplo:
{{token_auth}}
Parâmetros Bodyapplication/json
bases
array [object {6}] 
requerido
Array de objeto das bases
name
string 
requerido
Nome da base de referência
local
string 
requerido
Estado da base de referência
version
string 
requerido
Data da base de referência
status
boolean 
requerido
Utilização da base de referência
region
string  | null 
opcional
Região da base de referência (Apenas SBC e SETOP)
with_labor_charges
boolean  | null 
opcional
Lei social da base de referência (Apenas SEDOP)
Exemplo
{
    "bases": [
        {
            "name": "SINAPI",
            "local": "SP",
            "version": "11/2022",
            "status": true
        },
        {
            "name": "SBC",
            "local": "SP",
            "version": "11/2020",
            "status": true,
            "region": "SPO"
        }
    ]
}

Exemplos de Requisiçã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 -g --request POST 'https://api.orcafascio.com/api/v1/base/mybase/compositions/{{sinapi_composition_id}}/add_bases' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bases": [
        {
            "name": "SINAPI",
            "local": "SP",
            "version": "11/2022",
            "status": true
        },
        {
            "name": "SBC",
            "local": "SP",
            "version": "11/2020",
            "status": true,
            "region": "SPO"
        }
    ]
}'

Respostas

🟢200Success
application/json
Body
id
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
pnd
integer 
requerido
Preço não desonerado
pd
integer 
requerido
Preço desonerado
banks
object 
requerido
Items auxiliares da composição
SINAPI
object 
requerido
SBC
object 
requerido
SEDOP
object 
requerido
items
array [object] 
requerido
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": {
        "pnd": 0.0,
        "pd": 0.0
    },
    "banks": {
        "SINAPI": {
            "data": "11/2022",
            "estado": "SP",
            "relatorio": true
        },
        "SBC": {
            "data": "11/2020",
            "estado": "SP",
            "regiao": "SPO",
            "relatorio": true
        },
        "SEDOP": {
            "data": "10/2023",
            "estado": "PA",
            "ls": true,
            "relatorio": true
        }
    },
    "items": [],
    "created_at": "2024-03-06T11:04:47.008-03:00"
}
🟠401Not authorized
🟠404Not found
🔴500Internal server error
Página anterior
Deletar composição
Próxima página
Adicionar itens da composição