Financeiro · Referência

Despesas

Despesas da empresa (fornecedor, categoria, NF, veículo/OS vinculados).

Permissão: despesasAções: ler · criar · atualizar · exportarglobal (sem carteira)

GET/v1/despesasListar GET/v1/despesas/{id}Detalhar GET/v1/despesas/exportarExportar em lote POST/v1/despesasLançar despesa PATCH/v1/despesas/{id}Atualizar despesa

O objeto despesas

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`paid_at`	data	Pago em	ordenar
`due_date`	data	Vencimento	ordenar
`category`	texto	category	filtro
`subcategory`	texto	subcategory
`supplier`	texto	supplier
`supplier_cnpj`	texto	supplier cnpj
`description`	texto	Descrição
`amount`	decimal (string)	Valor	ordenar
`payment_method`	texto (enum)	payment method `pix` `cartao` `dinheiro` `transferencia` `boleto` `debito_automatico` `outros`	filtro
`status`	texto (enum)	Situação `pendente` `pago` `cancelado` `contestado`	filtro
`vehicle_id`	inteiro	ID do veículo	filtro
`rental_id`	inteiro	ID da locação
`os_id`	inteiro	os id	filtro
`nf_number`	texto	nf number
`notes`	texto	Observações
`created_by_user_id`	inteiro	ID do usuário que criou
`created_at`	data-hora	Criado em	ordenar
`updated_at`	data-hora	Atualizado em

Exemplo do objeto200 OK

{
    "id": 1024,
    "paid_at": "2026-10-15",
    "due_date": "2026-10-15",
    "category": "Filtros",
    "subcategory": "texto",
    "supplier": "Auto Peças Norte",
    "supplier_cnpj": "texto",
    "description": "Aluguel semanal",
    "amount": "150.00",
    "payment_method": "pix",
    "status": "pendente",
    "vehicle_id": 512,
    "rental_id": 512,
    "os_id": 512,
    "nf_number": "texto",
    "notes": "Cliente pediu boleto",
    "created_by_user_id": 512,
    "created_at": "2026-10-08T14:30:00-03:00",
    "updated_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`, `paid_at`, `due_date`, `amount`, `created_at` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `supplier`, `description`
`status`	texto (enum)	Situação — valor exato ou lista separada por vírgula `pendente` `pago` `cancelado` `contestado`
`category`	texto	category — valor exato ou lista separada por vírgula
`payment_method`	texto (enum)	payment method — valor exato ou lista separada por vírgula `pix` `cartao` `dinheiro` `transferencia` `boleto` `debito_automatico` `outros`
`vehicle_id`	inteiro	ID do veículo — valor exato ou lista separada por vírgula
`os_id`	inteiro	os id — 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)

Requisição

Testar ▸

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/despesas?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/despesas?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/despesas?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,
            "paid_at": "2026-10-15",
            "due_date": "2026-10-15",
            "category": "Filtros",
            "subcategory": "texto",
            "supplier": "Auto Peças Norte",
            "supplier_cnpj": "texto",
            "description": "Aluguel semanal"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

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/despesas/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/despesas/1024');
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/despesas/1024', {
  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/despesas/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,
        "paid_at": "2026-10-15",
        "due_date": "2026-10-15",
        "category": "Filtros",
        "subcategory": "texto",
        "supplier": "Auto Peças Norte",
        "supplier_cnpj": "texto",
        "description": "Aluguel semanal"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

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/despesas/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/despesas/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/despesas/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/despesas/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 Lançar despesa

Lançar despesa. Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`description`	texto	obrigatório	(até 500 caracteres)
`amount`	decimal	obrigatório
`category`	texto	opcional	Ex.: combustivel, oficina, peca, aluguel, folha, ipva… (até 60 caracteres)
`subcategory`	texto	opcional	(até 60 caracteres)
`supplier`	texto	opcional	(até 200 caracteres)
`supplier_cnpj`	texto	opcional	(até 20 caracteres)
`payment_method`	enum	opcional	`pix` `cartao` `dinheiro` `transferencia` `boleto` `debito_automatico` `outros`
`status`	enum	opcional	`pendente` `pago` `cancelado` `contestado`
`due_date`	data	opcional
`paid_at`	data	opcional	Data da despesa/pagamento (padrão: vencimento ou hoje; ao marcar pago sem data, usa hoje)
`vehicle_id`	inteiro	opcional
`rental_id`	inteiro	opcional
`os_id`	inteiro	opcional
`nf_number`	texto	opcional	(até 50 caracteres)
`notes`	texto	opcional	(até 5000 caracteres)

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/despesas" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"description":"Troca de pneus","category":"oficina","amount":"980.00","due_date":"2026-10-20","supplier":"Pneus Norte","vehicle_id":512}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/despesas');
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([
    'description' => 'Troca de pneus',
    'category' => 'oficina',
    'amount' => '980.00',
    'due_date' => '2026-10-20',
    'supplier' => 'Pneus Norte',
    'vehicle_id' => 512,
  ]),
]);
$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/despesas', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "description": "Troca de pneus",
      "category": "oficina",
      "amount": "980.00",
      "due_date": "2026-10-20",
      "supplier": "Pneus Norte",
      "vehicle_id": 512
  }),
});
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/despesas",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "description": "Troca de pneus",
        "category": "oficina",
        "amount": "980.00",
        "due_date": "2026-10-20",
        "supplier": "Pneus Norte",
        "vehicle_id": 512
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "paid_at": "2026-10-15",
        "due_date": "2026-10-15",
        "category": "Filtros",
        "subcategory": "texto",
        "supplier": "Auto Peças Norte",
        "supplier_cnpj": "texto",
        "description": "Aluguel semanal"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

PATCH Atualizar despesa

Atualizar despesa. Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`description`	texto	opcional	(até 500 caracteres)
`amount`	decimal	opcional
`category`	texto	opcional	Ex.: combustivel, oficina, peca, aluguel, folha, ipva… (até 60 caracteres)
`subcategory`	texto	opcional	(até 60 caracteres)
`supplier`	texto	opcional	(até 200 caracteres)
`supplier_cnpj`	texto	opcional	(até 20 caracteres)
`payment_method`	enum	opcional	`pix` `cartao` `dinheiro` `transferencia` `boleto` `debito_automatico` `outros`
`status`	enum	opcional	`pendente` `pago` `cancelado` `contestado`
`due_date`	data	opcional
`paid_at`	data	opcional	Data da despesa/pagamento (padrão: vencimento ou hoje; ao marcar pago sem data, usa hoje)
`vehicle_id`	inteiro	opcional
`rental_id`	inteiro	opcional
`os_id`	inteiro	opcional
`nf_number`	texto	opcional	(até 50 caracteres)
`notes`	texto	opcional	(até 5000 caracteres)

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/despesas/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"status":"pago","paid_at":"2026-10-20"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/despesas/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([
    'status' => 'pago',
    'paid_at' => '2026-10-20',
  ]),
]);
$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/despesas/1024', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "status": "pago",
      "paid_at": "2026-10-20"
  }),
});
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/despesas/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "status": "pago",
        "paid_at": "2026-10-20"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "paid_at": "2026-10-15",
        "due_date": "2026-10-15",
        "category": "Filtros",
        "subcategory": "texto",
        "supplier": "Auto Peças Norte",
        "supplier_cnpj": "texto",
        "description": "Aluguel semanal"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}