Oficina · Referência

Orçamentos

Orçamentos de peças e serviços para clientes/veículos.

Permissão: orcamentosAções: ler · criar · atualizar · excluir · exportar1 campo(s) LGPD

GET/v1/orcamentosListar GET/v1/orcamentos/{id}Detalhar GET/v1/orcamentos/{id}/itensRelação: Itens de orçamento GET/v1/orcamentos/exportarExportar em lote POST/v1/orcamentosCriar orçamento com itens PATCH/v1/orcamentos/{id}Atualizar orçamento DELETE/v1/orcamentos/{id}Excluir orçamento em rascunho

O objeto orçamentos

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`client_id`	inteiro	ID do cliente	filtro
`client_name`	texto	client name	LGPD
`vehicle_id`	inteiro	ID do veículo	filtro
`plate`	texto	Placa	filtro
`vehicle_model`	texto	vehicle model
`total_amount`	decimal (string)	Valor total	ordenar
`status`	texto	Situação	filtro
`notes`	texto	Observações
`validade_dias`	inteiro	validade dias
`created_by_user_id`	inteiro	ID do usuário que criou
`created_at`	data-hora	Criado em	ordenar
`updated_at`	data-hora	Atualizado em
`sent_at`	data-hora	sent at

Exemplo do objeto200 OK

{
    "id": 1024,
    "client_id": 512,
    "client_name": "Maria Fernanda Souza",
    "vehicle_id": 512,
    "plate": "ABC1D23",
    "vehicle_model": "RENAULT LOGAN",
    "total_amount": "450.00",
    "status": "ativo",
    "notes": "Cliente pediu boleto",
    "validade_dias": 1,
    "created_by_user_id": 512,
    "created_at": "2026-10-08T14:30:00-03:00",
    "updated_at": "2026-10-08T14:30:00-03:00",
    "sent_at": "2026-10-08T14:30:00-03:00"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `created_at`, `total_amount` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `client_name`, `plate`
`status`	texto	Situação — valor exato ou lista separada por vírgula
`client_id`	inteiro	ID do cliente — valor exato ou lista separada por vírgula
`vehicle_id`	inteiro	ID do veículo — valor exato ou lista separada por vírgula
`plate`	texto	Placa — valor exato ou lista separada por vírgula
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (pela coluna de atualização)
`incluir`	texto	Só no detalhe. Relações: `itens`

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/orcamentos?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/orcamentos?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/orcamentos?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/orcamentos?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "client_id": 512,
            "client_name": "Maria Fernanda Souza",
            "vehicle_id": 512,
            "plate": "ABC1D23",
            "vehicle_model": "RENAULT LOGAN",
            "total_amount": "450.00",
            "status": "ativo"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Use incluir para embutir relações (cada uma exige Ler no módulo relacionado).

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/orcamentos/1024?incluir=itens" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/orcamentos/1024?incluir=itens');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/orcamentos/1024?incluir=itens', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/orcamentos/1024?incluir=itens",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "client_id": 512,
        "client_name": "Maria Fernanda Souza",
        "vehicle_id": 512,
        "plate": "ABC1D23",
        "vehicle_model": "RENAULT LOGAN",
        "total_amount": "450.00",
        "status": "ativo"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`itens`	Itens de orçamento	lista paginada	`/v1/orcamentos/{id}/itens`

GET Exportar em lote

Até 1000 registros por chamada, paginando por cursor. Requer Ler e Exportar. Aceita os mesmos filtros da listagem e formato=csv. Detalhes no guia Exportação em lote.

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/orcamentos/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/orcamentos/exportar?limite=1000');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/orcamentos/exportar?limite=1000', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/orcamentos/exportar?limite=1000",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

POST Criar orçamento com itens

Criar orçamento com itens (total calculado). Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`client_id`	inteiro	opcional
`vehicle_id`	inteiro	opcional
`notes`	texto	opcional	(até 600 caracteres)
`validade_dias`	inteiro	opcional
`itens`	lista	obrigatório	[{item_type: part\|service\|other, description, qty, unit_price}]

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/orcamentos" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"vehicle_id":512,"validade_dias":7,"itens":[{"item_type":"part","description":"Pastilha de freio","qty":1,"unit_price":"180.00"},{"item_type":"service","description":"Mão de obra","qty":1,"unit_price":"90.00"}]}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/orcamentos');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'vehicle_id' => 512,
    'validade_dias' => 7,
    'itens' => [
      [
        'item_type' => 'part',
        'description' => 'Pastilha de freio',
        'qty' => 1,
        'unit_price' => '180.00',
      ],
      [
        'item_type' => 'service',
        'description' => 'Mão de obra',
        'qty' => 1,
        'unit_price' => '90.00',
      ],
    ],
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/orcamentos', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "vehicle_id": 512,
      "validade_dias": 7,
      "itens": [
          {
              "item_type": "part",
              "description": "Pastilha de freio",
              "qty": 1,
              "unit_price": "180.00"
          },
          {
              "item_type": "service",
              "description": "Mão de obra",
              "qty": 1,
              "unit_price": "90.00"
          }
      ]
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/orcamentos",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "vehicle_id": 512,
        "validade_dias": 7,
        "itens": [
            {
                "item_type": "part",
                "description": "Pastilha de freio",
                "qty": 1,
                "unit_price": "180.00"
            },
            {
                "item_type": "service",
                "description": "Mão de obra",
                "qty": 1,
                "unit_price": "90.00"
            }
        ]
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "client_id": 512,
        "client_name": "Maria Fernanda Souza",
        "vehicle_id": 512,
        "plate": "ABC1D23",
        "vehicle_model": "RENAULT LOGAN",
        "total_amount": "450.00",
        "status": "ativo"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

PATCH Atualizar orçamento

Atualizar orçamento (itens enviados substituem os atuais). Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`client_id`	inteiro	opcional
`vehicle_id`	inteiro	opcional
`notes`	texto	opcional	(até 600 caracteres)
`validade_dias`	inteiro	opcional
`itens`	lista	opcional	[{item_type: part\|service\|other, description, qty, unit_price}]

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X PATCH "https://apimapogos.sixinformatica.com/v1/orcamentos/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"notes":"Validade estendida","validade_dias":15}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/orcamentos/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'notes' => 'Validade estendida',
    'validade_dias' => 15,
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/orcamentos/1024', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "notes": "Validade estendida",
      "validade_dias": 15
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "PATCH",
    "https://apimapogos.sixinformatica.com/v1/orcamentos/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "notes": "Validade estendida",
        "validade_dias": 15
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "client_id": 512,
        "client_name": "Maria Fernanda Souza",
        "vehicle_id": 512,
        "plate": "ABC1D23",
        "vehicle_model": "RENAULT LOGAN",
        "total_amount": "450.00",
        "status": "ativo"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

DELETE Excluir orçamento em rascunho

Excluir orçamento em rascunho. Requer excluir.

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X DELETE "https://apimapogos.sixinformatica.com/v1/orcamentos/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/orcamentos/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/orcamentos/1024', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "DELETE",
    "https://apimapogos.sixinformatica.com/v1/orcamentos/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "cancelado": true
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

Recursos incluídos neste módulo

Estes recursos usam a mesma permissão de Orçamentos:

Rota	Recurso	Descrição	Campos
`/v1/orcamentos_itens`	Itens de orçamento	Peças e serviços do orçamento.	`id`, `orcamento_id`, `item_type`, `description`, `qty`, `unit_price`, `total`, `created_at`