Operação · Referência

Encerramento & Pós-Encerramento

Encerramento do contrato (KM, avarias, caução, multas, saldo financeiro) e o acompanhamento de pendências após o encerramento. Pela API: leitura completa e atualização do acompanhamento pós-encerramento; o encerramento em si é feito no painel.

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

GET/v1/pos_encerramentoListar GET/v1/pos_encerramento/{id}Detalhar GET/v1/pos_encerramento/{id}/locacaoRelação: Locações GET/v1/pos_encerramento/{id}/acompanhamentoRelação: Pendências pós-encerramento GET/v1/pos_encerramento/{id}/eventosRelação: Histórico do encerramento GET/v1/pos_encerramento/{id}/arquivosRelação: Arquivos do encerramento GET/v1/pos_encerramento/exportarExportar em lote

O objeto encerramento & pós-encerramento

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`rental_id`	inteiro	ID da locação	filtro
`status`	texto (enum)	Situação `draft` `validated` `closed` `rejected`	filtro
`km_inicial`	inteiro	km inicial
`km_final`	inteiro	km final
`km_rodados`	inteiro	km rodados
`dias_locados`	inteiro	dias locados
`media_km_dia`	decimal (string)	media km dia
`km_excedente`	inteiro	km excedente
`multa_km_excedente`	decimal (string)	multa km excedente
`multa_km_excedente_pago`	decimal (string)	multa km excedente pago
`data_inicial`	data-hora	data inicial
`data_final`	data-hora	data final
`limpeza`	texto (enum)	limpeza `limpo` `sujo` `muito_sujo`
`combustivel`	texto (enum)	combustivel `vazio` `1_4` `1_2` `3_4` `cheio`
`abastecimento_tipo`	texto (enum)	abastecimento tipo `sem` `parcial` `integral`
`abastecimento_valor`	decimal (string)	abastecimento valor
`funcionando_normalmente`	booleano	funcionando normalmente
`entregue_com_danos`	booleano	entregue com danos
`possui_avarias`	booleano	possui avarias
`possui_avarias_novas`	booleano	possui avarias novas
`avarias_descricao`	texto	avarias descricao
`avarias_valor_estimado`	decimal (string)	avarias valor estimado
`avarias_total_pecas`	decimal (string)	avarias total pecas
`avarias_observacao`	texto	avarias observacao
`avarias_outros_descricao`	texto	avarias outros descricao
`avarias_outros_valor`	decimal (string)	avarias outros valor
`vistoria_id`	inteiro	vistoria id
`caucao_valor_contrato`	decimal (string)	caucao valor contrato
`caucao_saldo_disponivel`	decimal (string)	caucao saldo disponivel
`caucao_descontos`	decimal (string)	caucao descontos
`caucao_destino`	texto (enum)	caucao destino `devolver` `parcial` `reter`	filtro
`caucao_valor_devolver`	decimal (string)	caucao valor devolver
`caucao_motivos_json`	objeto	caucao motivos json
`caucao_observacao`	texto	caucao observacao
`caucao_retencao_ate`	data	caucao retencao ate
`caucao_retencao_status`	texto (enum)	caucao retencao status `nao_aplicavel` `retida` `parcialmente_liberada` `liberada`	filtro
`caucao_valor_liberado`	decimal (string)	caucao valor liberado
`caucao_liberada_em`	data-hora	caucao liberada em
`caucao_liberada_por_nome`	texto	caucao liberada por nome
`caucao_revisao_nota`	texto	caucao revisao nota
`multas_qtd_pendentes`	inteiro	multas qtd pendentes
`multas_total_pendente`	decimal (string)	multas total pendente
`multas_valor_cobrar`	decimal (string)	multas valor cobrar
`multas_cobradas_ids`	texto	multas cobradas ids
`multas_ciencia`	booleano	multas ciencia
`multas_observacao`	texto	multas observacao
`fin_acordos_abertos`	inteiro	fin acordos abertos
`fin_parcelas_abertas`	inteiro	fin parcelas abertas
`fin_pix_pendente`	inteiro	fin pix pendente
`fin_total_pago`	decimal (string)	fin total pago
`fin_total_pendente`	decimal (string)	fin total pendente
`fin_descontos`	decimal (string)	fin descontos
`fin_saldo_cliente`	decimal (string)	fin saldo cliente
`fin_observacao`	texto	fin observacao
`desbloqueio_qtd`	inteiro	desbloqueio qtd
`guincho_valor`	decimal (string)	guincho valor
`equipe_busca_valor`	decimal (string)	equipe busca valor
`diarias_atraso_qtd`	inteiro	diarias atraso qtd
`diarias_atraso_valor`	decimal (string)	diarias atraso valor
`alertas_json`	objeto	alertas json
`bloqueios_json`	objeto	bloqueios json
`created_by_name`	texto	created by name
`created_at`	data-hora	Criado em	ordenar
`validated_at`	data-hora	validated at
`closed_by_name`	texto	closed by name
`closed_at`	data-hora	closed at	ordenar
`closed_location`	texto	closed location	LGPD
`pdf_generated_at`	data-hora	pdf generated at
`notes`	texto	Observações
`updated_at`	data-hora	Atualizado em	ordenar

Exemplo do objeto200 OK

{
    "id": 1024,
    "rental_id": 512,
    "status": "draft",
    "km_inicial": 45210,
    "km_final": 45210,
    "km_rodados": 45210,
    "dias_locados": 1,
    "media_km_dia": "150.00",
    "km_excedente": 45210,
    "multa_km_excedente": "150.00",
    "multa_km_excedente_pago": "150.00",
    "data_inicial": "2026-10-08T14:30:00-03:00",
    "data_final": "2026-10-08T14:30:00-03:00",
    "limpeza": "limpo",
    "combustivel": "vazio",
    "abastecimento_tipo": "sem",
    "abastecimento_valor": "150.00",
    "funcionando_normalmente": false,
    "entregue_com_danos": false,
    "possui_avarias": false,
    "possui_avarias_novas": false,
    "avarias_descricao": "texto",
    "avarias_valor_estimado": "150.00",
    "avarias_total_pecas": "450.00",
    "avarias_observacao": "texto",
    "avarias_outros_descricao": "texto",
    "avarias_outros_valor": "150.00",
    "vistoria_id": 512,
    "caucao_valor_contrato": "150.00",
    "caucao_saldo_disponivel": "150.00",
    "caucao_descontos": "150.00",
    "caucao_destino": "devolver",
    "caucao_valor_devolver": "150.00",
    "caucao_motivos_json": {},
    "caucao_observacao": "texto",
    "caucao_retencao_ate": "2026-10-15",
    "caucao_retencao_status": "nao_aplicavel",
    "caucao_valor_liberado": "150.00",
    "caucao_liberada_em": "2026-10-08T14:30:00-03:00",
    "caucao_liberada_por_nome": "texto",
    "caucao_revisao_nota": "texto",
    "multas_qtd_pendentes": 1,
    "multas_total_pendente": "450.00",
    "multas_valor_cobrar": "150.00",
    "multas_cobradas_ids": "texto",
    "multas_ciencia": false,
    "multas_observacao": "texto",
    "fin_acordos_abertos": 1,
    "fin_parcelas_abertas": 1,
    "fin_pix_pendente": 1,
    "fin_total_pago": "450.00",
    "fin_total_pendente": "450.00",
    "fin_descontos": "150.00",
    "fin_saldo_cliente": "150.00",
    "fin_observacao": "texto",
    "desbloqueio_qtd": 1,
    "guincho_valor": "150.00",
    "equipe_busca_valor": "150.00",
    "diarias_atraso_qtd": 1,
    "diarias_atraso_valor": "150.00",
    "alertas_json": {},
    "bloqueios_json": {},
    "created_by_name": "texto",
    "created_at": "2026-10-08T14:30:00-03:00",
    "validated_at": "2026-10-08T14:30:00-03:00",
    "closed_by_name": "texto",
    "closed_at": "2026-10-08T14:30:00-03:00",
    "closed_location": "texto",
    "pdf_generated_at": "2026-10-08T14:30:00-03:00",
    "notes": "Cliente pediu boleto",
    "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`, `created_at`, `closed_at`, `updated_at` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`status`	texto (enum)	Situação — valor exato ou lista separada por vírgula `draft` `validated` `closed` `rejected`
`rental_id`	inteiro	ID da locação — valor exato ou lista separada por vírgula
`caucao_retencao_status`	texto (enum)	caucao retencao status — valor exato ou lista separada por vírgula `nao_aplicavel` `retida` `parcialmente_liberada` `liberada`
`caucao_destino`	texto (enum)	caucao destino — valor exato ou lista separada por vírgula `devolver` `parcial` `reter`
`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: `locacao`, `acompanhamento`, `eventos`, `arquivos`

Requisição

Testar ▸

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pos_encerramento?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/pos_encerramento?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/pos_encerramento?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,
            "rental_id": 512,
            "status": "draft",
            "km_inicial": 45210,
            "km_final": 45210,
            "km_rodados": 45210,
            "dias_locados": 1,
            "media_km_dia": "150.00"
        }
    ],
    "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/pos_encerramento/1024?incluir=locacao" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pos_encerramento/1024?incluir=locacao');
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/pos_encerramento/1024?incluir=locacao', {
  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/pos_encerramento/1024?incluir=locacao",
    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,
        "rental_id": 512,
        "status": "draft",
        "km_inicial": 45210,
        "km_final": 45210,
        "km_rodados": 45210,
        "dias_locados": 1,
        "media_km_dia": "150.00"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`locacao`	Locações	um registro	`/v1/pos_encerramento/{id}/locacao`
`acompanhamento`	Pendências pós-encerramento	lista paginada	`/v1/pos_encerramento/{id}/acompanhamento`
`eventos`	Histórico do encerramento	lista paginada	`/v1/pos_encerramento/{id}/eventos`
`arquivos`	Arquivos do encerramento	lista paginada	`/v1/pos_encerramento/{id}/arquivos`

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pos_encerramento/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/pos_encerramento/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/pos_encerramento/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"])

Recursos incluídos neste módulo

Estes recursos usam a mesma permissão de Encerramento & Pós-Encerramento:

Rota	Recurso	Descrição	Campos
`/v1/pos_encerramento_acompanhamento`	Pendências pós-encerramento	Acompanhamento após o encerramento: checklist, pendências e devolução da caução.	`id`, `rental_id`, `status`, `responsavel_user_id`, `checklist_json`, `pendencias`, `caucao_forma`, `caucao_data_prevista` …
`/v1/pos_encerramento_eventos`	Histórico do encerramento	Linha do tempo do encerramento (quem fez o quê).	`id`, `closure_id`, `rental_id`, `event_type`, `user_id`, `user_name`, `payload_json`, `created_at`
`/v1/pos_encerramento_arquivos`	Arquivos do encerramento	Metadados das fotos/arquivos anexados ao encerramento.	`id`, `closure_id`, `rental_id`, `category`, `original_name`, `mime_type`, `byte_size`, `uploaded_by_name` …

Eventos de webhook

locacao.encerrada — veja Webhooks.